# Models

## The fixedPrice object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"fixedPrice":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The fixed amount to charge for the subscription"}}}}
```

## The amount object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}}}}}
```

## The Model1 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model1":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"string","description":"The starting quantity for the tier."},"endingQuantity":{"type":"string","description":"The ending quantity for the tier. Optional for the last tier."},"amount":{"$ref":"#/components/schemas/amount"}}},"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}}}}}
```

## The tiers object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"tiers":{"type":"array","description":"An array of pricing tiers which are used for billing volume/tiered plans.","items":{"$ref":"#/components/schemas/Model1"}},"Model1":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"string","description":"The starting quantity for the tier."},"endingQuantity":{"type":"string","description":"The ending quantity for the tier. Optional for the last tier."},"amount":{"$ref":"#/components/schemas/amount"}}},"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}}}}}
```

## The pricingScheme object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"pricingScheme":{"type":"object","properties":{"version":{"maximum":999,"type":"number","description":"The version of the pricing scheme."},"fixedPrice":{"$ref":"#/components/schemas/fixedPrice"},"pricingModel":{"type":"string","description":"The pricing model for tiered plan","enum":["VOLUME","TIERED"]},"tiers":{"$ref":"#/components/schemas/tiers"}},"description":"The active pricing scheme for this billing cycle."},"fixedPrice":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The fixed amount to charge for the subscription"},"tiers":{"type":"array","description":"An array of pricing tiers which are used for billing volume/tiered plans.","items":{"$ref":"#/components/schemas/Model1"}},"Model1":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"string","description":"The starting quantity for the tier."},"endingQuantity":{"type":"string","description":"The ending quantity for the tier. Optional for the last tier."},"amount":{"$ref":"#/components/schemas/amount"}}},"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}}}}}
```

## The frequency object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"frequency":{"required":["intervalUnit"],"type":"object","properties":{"intervalUnit":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["DAY","WEEK","MONTH","YEAR"]},"intervalCount":{"type":"number","description":"The number of intervals after which a subscriber is billed."}}}}}}
```

## The Model2 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model2":{"required":["frequency","sequence","tenureType"],"type":"object","properties":{"pricingScheme":{"$ref":"#/components/schemas/pricingScheme"},"frequency":{"$ref":"#/components/schemas/frequency"},"tenureType":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["REGULAR","TRIAL"]},"sequence":{"type":"number","description":"The order in which this cycle is to run among other billing cycles."},"totalCycles":{"type":"number","description":"The number of times this billing cycle gets executed."}}},"pricingScheme":{"type":"object","properties":{"version":{"maximum":999,"type":"number","description":"The version of the pricing scheme."},"fixedPrice":{"$ref":"#/components/schemas/fixedPrice"},"pricingModel":{"type":"string","description":"The pricing model for tiered plan","enum":["VOLUME","TIERED"]},"tiers":{"$ref":"#/components/schemas/tiers"}},"description":"The active pricing scheme for this billing cycle."},"fixedPrice":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The fixed amount to charge for the subscription"},"tiers":{"type":"array","description":"An array of pricing tiers which are used for billing volume/tiered plans.","items":{"$ref":"#/components/schemas/Model1"}},"Model1":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"string","description":"The starting quantity for the tier."},"endingQuantity":{"type":"string","description":"The ending quantity for the tier. Optional for the last tier."},"amount":{"$ref":"#/components/schemas/amount"}}},"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}},"frequency":{"required":["intervalUnit"],"type":"object","properties":{"intervalUnit":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["DAY","WEEK","MONTH","YEAR"]},"intervalCount":{"type":"number","description":"The number of intervals after which a subscriber is billed."}}}}}}
```

## The billingCycles object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"billingCycles":{"minItems":1,"type":"array","description":"An array of billing cycles for trial billing and regular billing","items":{"$ref":"#/components/schemas/Model2"}},"Model2":{"required":["frequency","sequence","tenureType"],"type":"object","properties":{"pricingScheme":{"$ref":"#/components/schemas/pricingScheme"},"frequency":{"$ref":"#/components/schemas/frequency"},"tenureType":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["REGULAR","TRIAL"]},"sequence":{"type":"number","description":"The order in which this cycle is to run among other billing cycles."},"totalCycles":{"type":"number","description":"The number of times this billing cycle gets executed."}}},"pricingScheme":{"type":"object","properties":{"version":{"maximum":999,"type":"number","description":"The version of the pricing scheme."},"fixedPrice":{"$ref":"#/components/schemas/fixedPrice"},"pricingModel":{"type":"string","description":"The pricing model for tiered plan","enum":["VOLUME","TIERED"]},"tiers":{"$ref":"#/components/schemas/tiers"}},"description":"The active pricing scheme for this billing cycle."},"fixedPrice":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The fixed amount to charge for the subscription"},"tiers":{"type":"array","description":"An array of pricing tiers which are used for billing volume/tiered plans.","items":{"$ref":"#/components/schemas/Model1"}},"Model1":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"string","description":"The starting quantity for the tier."},"endingQuantity":{"type":"string","description":"The ending quantity for the tier. Optional for the last tier."},"amount":{"$ref":"#/components/schemas/amount"}}},"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}},"frequency":{"required":["intervalUnit"],"type":"object","properties":{"intervalUnit":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["DAY","WEEK","MONTH","YEAR"]},"intervalCount":{"type":"number","description":"The number of intervals after which a subscriber is billed."}}}}}}
```

## The setupFee object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"setupFee":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The initial set-up fee for the service."}}}}
```

## The paymentPreferences object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"paymentPreferences":{"type":"object","properties":{"autoBillOutstanding":{"type":"boolean","description":"Indicates whether to automatically bill the outstanding amount in the next billing cycle."},"setupFee":{"$ref":"#/components/schemas/setupFee"},"setupFeeFailureAction":{"type":"string","description":"The action to take on the subscription if the initial payment for the setup fails.","enum":["CONTINUE","CANCEL"]},"paymentFailureThreshold":{"type":"number","description":"The maximum number of payment failures before a subscription is suspended."}},"description":"The payment preferences for a subscription."},"setupFee":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The initial set-up fee for the service."}}}}
```

## The taxes object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"taxes":{"required":["percentage"],"type":"object","properties":{"percentage":{"type":"string","description":"The tax percentage on the billing amount."},"inclusive":{"type":"boolean","description":"Indicates whether the tax was already included in the billing amount."}},"description":"The tax details."}}}}
```

## The Model3 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model3":{"required":["billingCycles","createTime","name","paymentPreferences"],"type":"object","properties":{"id":{"maxLength":50,"minLength":6,"type":"string","description":"Filters the response by a Product ID."},"name":{"maxLength":127,"type":"string","description":"The plan name"},"billingCycles":{"$ref":"#/components/schemas/billingCycles"},"paymentPreferences":{"$ref":"#/components/schemas/paymentPreferences"},"status":{"type":"string","description":"The initial state of the plan","enum":["ACTIVE","INACTIVE","CREATED"]},"description":{"maxLength":127,"type":"string","description":"The detailed description of the plan."},"taxes":{"$ref":"#/components/schemas/taxes"},"quantitySupported":{"type":"boolean","description":"Indicates whether you can subscribe to this plan by providing a quantity for the goods or service."},"createTime":{"type":"string","description":"The date and time when the billing plan was created.","format":"date"},"updateTime":{"type":"string","description":"The date and time when the billing plan was updated.","format":"date"}}},"billingCycles":{"minItems":1,"type":"array","description":"An array of billing cycles for trial billing and regular billing","items":{"$ref":"#/components/schemas/Model2"}},"Model2":{"required":["frequency","sequence","tenureType"],"type":"object","properties":{"pricingScheme":{"$ref":"#/components/schemas/pricingScheme"},"frequency":{"$ref":"#/components/schemas/frequency"},"tenureType":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["REGULAR","TRIAL"]},"sequence":{"type":"number","description":"The order in which this cycle is to run among other billing cycles."},"totalCycles":{"type":"number","description":"The number of times this billing cycle gets executed."}}},"pricingScheme":{"type":"object","properties":{"version":{"maximum":999,"type":"number","description":"The version of the pricing scheme."},"fixedPrice":{"$ref":"#/components/schemas/fixedPrice"},"pricingModel":{"type":"string","description":"The pricing model for tiered plan","enum":["VOLUME","TIERED"]},"tiers":{"$ref":"#/components/schemas/tiers"}},"description":"The active pricing scheme for this billing cycle."},"fixedPrice":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The fixed amount to charge for the subscription"},"tiers":{"type":"array","description":"An array of pricing tiers which are used for billing volume/tiered plans.","items":{"$ref":"#/components/schemas/Model1"}},"Model1":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"string","description":"The starting quantity for the tier."},"endingQuantity":{"type":"string","description":"The ending quantity for the tier. Optional for the last tier."},"amount":{"$ref":"#/components/schemas/amount"}}},"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}},"frequency":{"required":["intervalUnit"],"type":"object","properties":{"intervalUnit":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["DAY","WEEK","MONTH","YEAR"]},"intervalCount":{"type":"number","description":"The number of intervals after which a subscriber is billed."}}},"paymentPreferences":{"type":"object","properties":{"autoBillOutstanding":{"type":"boolean","description":"Indicates whether to automatically bill the outstanding amount in the next billing cycle."},"setupFee":{"$ref":"#/components/schemas/setupFee"},"setupFeeFailureAction":{"type":"string","description":"The action to take on the subscription if the initial payment for the setup fails.","enum":["CONTINUE","CANCEL"]},"paymentFailureThreshold":{"type":"number","description":"The maximum number of payment failures before a subscription is suspended."}},"description":"The payment preferences for a subscription."},"setupFee":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The initial set-up fee for the service."},"taxes":{"required":["percentage"],"type":"object","properties":{"percentage":{"type":"string","description":"The tax percentage on the billing amount."},"inclusive":{"type":"boolean","description":"Indicates whether the tax was already included in the billing amount."}},"description":"The tax details."}}}}
```

## The plans object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"plans":{"type":"array","items":{"$ref":"#/components/schemas/Model3"}},"Model3":{"required":["billingCycles","createTime","name","paymentPreferences"],"type":"object","properties":{"id":{"maxLength":50,"minLength":6,"type":"string","description":"Filters the response by a Product ID."},"name":{"maxLength":127,"type":"string","description":"The plan name"},"billingCycles":{"$ref":"#/components/schemas/billingCycles"},"paymentPreferences":{"$ref":"#/components/schemas/paymentPreferences"},"status":{"type":"string","description":"The initial state of the plan","enum":["ACTIVE","INACTIVE","CREATED"]},"description":{"maxLength":127,"type":"string","description":"The detailed description of the plan."},"taxes":{"$ref":"#/components/schemas/taxes"},"quantitySupported":{"type":"boolean","description":"Indicates whether you can subscribe to this plan by providing a quantity for the goods or service."},"createTime":{"type":"string","description":"The date and time when the billing plan was created.","format":"date"},"updateTime":{"type":"string","description":"The date and time when the billing plan was updated.","format":"date"}}},"billingCycles":{"minItems":1,"type":"array","description":"An array of billing cycles for trial billing and regular billing","items":{"$ref":"#/components/schemas/Model2"}},"Model2":{"required":["frequency","sequence","tenureType"],"type":"object","properties":{"pricingScheme":{"$ref":"#/components/schemas/pricingScheme"},"frequency":{"$ref":"#/components/schemas/frequency"},"tenureType":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["REGULAR","TRIAL"]},"sequence":{"type":"number","description":"The order in which this cycle is to run among other billing cycles."},"totalCycles":{"type":"number","description":"The number of times this billing cycle gets executed."}}},"pricingScheme":{"type":"object","properties":{"version":{"maximum":999,"type":"number","description":"The version of the pricing scheme."},"fixedPrice":{"$ref":"#/components/schemas/fixedPrice"},"pricingModel":{"type":"string","description":"The pricing model for tiered plan","enum":["VOLUME","TIERED"]},"tiers":{"$ref":"#/components/schemas/tiers"}},"description":"The active pricing scheme for this billing cycle."},"fixedPrice":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The fixed amount to charge for the subscription"},"tiers":{"type":"array","description":"An array of pricing tiers which are used for billing volume/tiered plans.","items":{"$ref":"#/components/schemas/Model1"}},"Model1":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"string","description":"The starting quantity for the tier."},"endingQuantity":{"type":"string","description":"The ending quantity for the tier. Optional for the last tier."},"amount":{"$ref":"#/components/schemas/amount"}}},"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}},"frequency":{"required":["intervalUnit"],"type":"object","properties":{"intervalUnit":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["DAY","WEEK","MONTH","YEAR"]},"intervalCount":{"type":"number","description":"The number of intervals after which a subscriber is billed."}}},"paymentPreferences":{"type":"object","properties":{"autoBillOutstanding":{"type":"boolean","description":"Indicates whether to automatically bill the outstanding amount in the next billing cycle."},"setupFee":{"$ref":"#/components/schemas/setupFee"},"setupFeeFailureAction":{"type":"string","description":"The action to take on the subscription if the initial payment for the setup fails.","enum":["CONTINUE","CANCEL"]},"paymentFailureThreshold":{"type":"number","description":"The maximum number of payment failures before a subscription is suspended."}},"description":"The payment preferences for a subscription."},"setupFee":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The initial set-up fee for the service."},"taxes":{"required":["percentage"],"type":"object","properties":{"percentage":{"type":"string","description":"The tax percentage on the billing amount."},"inclusive":{"type":"boolean","description":"Indicates whether the tax was already included in the billing amount."}},"description":"The tax details."}}}}
```

## The Model4 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model4":{"type":"object","properties":{"plans":{"$ref":"#/components/schemas/plans"},"totalItems":{"type":"number","description":"The total number of items."},"totalPages":{"type":"number","description":"The total number of pages."}}},"plans":{"type":"array","items":{"$ref":"#/components/schemas/Model3"}},"Model3":{"required":["billingCycles","createTime","name","paymentPreferences"],"type":"object","properties":{"id":{"maxLength":50,"minLength":6,"type":"string","description":"Filters the response by a Product ID."},"name":{"maxLength":127,"type":"string","description":"The plan name"},"billingCycles":{"$ref":"#/components/schemas/billingCycles"},"paymentPreferences":{"$ref":"#/components/schemas/paymentPreferences"},"status":{"type":"string","description":"The initial state of the plan","enum":["ACTIVE","INACTIVE","CREATED"]},"description":{"maxLength":127,"type":"string","description":"The detailed description of the plan."},"taxes":{"$ref":"#/components/schemas/taxes"},"quantitySupported":{"type":"boolean","description":"Indicates whether you can subscribe to this plan by providing a quantity for the goods or service."},"createTime":{"type":"string","description":"The date and time when the billing plan was created.","format":"date"},"updateTime":{"type":"string","description":"The date and time when the billing plan was updated.","format":"date"}}},"billingCycles":{"minItems":1,"type":"array","description":"An array of billing cycles for trial billing and regular billing","items":{"$ref":"#/components/schemas/Model2"}},"Model2":{"required":["frequency","sequence","tenureType"],"type":"object","properties":{"pricingScheme":{"$ref":"#/components/schemas/pricingScheme"},"frequency":{"$ref":"#/components/schemas/frequency"},"tenureType":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["REGULAR","TRIAL"]},"sequence":{"type":"number","description":"The order in which this cycle is to run among other billing cycles."},"totalCycles":{"type":"number","description":"The number of times this billing cycle gets executed."}}},"pricingScheme":{"type":"object","properties":{"version":{"maximum":999,"type":"number","description":"The version of the pricing scheme."},"fixedPrice":{"$ref":"#/components/schemas/fixedPrice"},"pricingModel":{"type":"string","description":"The pricing model for tiered plan","enum":["VOLUME","TIERED"]},"tiers":{"$ref":"#/components/schemas/tiers"}},"description":"The active pricing scheme for this billing cycle."},"fixedPrice":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The fixed amount to charge for the subscription"},"tiers":{"type":"array","description":"An array of pricing tiers which are used for billing volume/tiered plans.","items":{"$ref":"#/components/schemas/Model1"}},"Model1":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"string","description":"The starting quantity for the tier."},"endingQuantity":{"type":"string","description":"The ending quantity for the tier. Optional for the last tier."},"amount":{"$ref":"#/components/schemas/amount"}}},"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}},"frequency":{"required":["intervalUnit"],"type":"object","properties":{"intervalUnit":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["DAY","WEEK","MONTH","YEAR"]},"intervalCount":{"type":"number","description":"The number of intervals after which a subscriber is billed."}}},"paymentPreferences":{"type":"object","properties":{"autoBillOutstanding":{"type":"boolean","description":"Indicates whether to automatically bill the outstanding amount in the next billing cycle."},"setupFee":{"$ref":"#/components/schemas/setupFee"},"setupFeeFailureAction":{"type":"string","description":"The action to take on the subscription if the initial payment for the setup fails.","enum":["CONTINUE","CANCEL"]},"paymentFailureThreshold":{"type":"number","description":"The maximum number of payment failures before a subscription is suspended."}},"description":"The payment preferences for a subscription."},"setupFee":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The initial set-up fee for the service."},"taxes":{"required":["percentage"],"type":"object","properties":{"percentage":{"type":"string","description":"The tax percentage on the billing amount."},"inclusive":{"type":"boolean","description":"Indicates whether the tax was already included in the billing amount."}},"description":"The tax details."}}}}
```

## The details object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"details":{"type":"object"}}}}
```

## The Model5 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model5":{"required":["code","message"],"type":"object","properties":{"code":{"type":"number","description":"A 3-digit code which uniquely identify an error."},"details":{"$ref":"#/components/schemas/details"},"message":{"type":"string","description":"A description of the error."},"timestamp":{"type":"string","description":"Error timestamp","format":"date"}}},"details":{"type":"object"}}}}
```

## The Model6 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model6":{"required":["createdAt","name","type","updatedAt"],"type":"object","properties":{"id":{"maxLength":50,"minLength":6,"type":"string","description":"The ID of the product. You can specify the SKU for the product. If you omit the ID, the system generates it. System-generated IDs have the PROD- prefix"},"name":{"maxLength":127,"minLength":1,"type":"string","description":"The product name"},"description":{"maxLength":256,"minLength":1,"type":"string","description":"The product description"},"type":{"type":"string","description":"The product type. Indicates whether the product is physical or tangible goods, or a service","enum":["PHYSICAL","DIGITAL","SERVICE"]},"category":{"type":"string","description":"The product category","enum":["AC_REFRIGERATION_REPAIR","ACADEMIC_SOFTWARE","ACCESSORIES","ACCOUNTING","ADULT","ADVERTISING","AFFILIATED_AUTO_RENTAL","AGENCIES","AGGREGATORS","AGRICULTURAL_COOPERATIVE_FOR_MAIL_ORDER","AIR_CARRIERS_AIRLINES","AIRLINES","AIRPORTS_FLYING_FIELDS","ALCOHOLIC_BEVERAGES","AMUSEMENT_PARKS_CARNIVALS","ANIMATION","ANTIQUES","APPLIANCES","AQUARIAMS_SEAQUARIUMS_DOLPHINARIUMS","ARCHITECTURAL_ENGINEERING_AND_SURVEYING_SERVICES","ART_AND_CRAFT_SUPPLIES","ART_DEALERS_AND_GALLERIES","ARTIFACTS_GRAVE_RELATED_AND_NATIVE_AMERICAN_CRAFTS","ARTS_AND_CRAFTS","ARTS_CRAFTS_AND_COLLECTIBLES","AUDIO_BOOKS","AUTO_ASSOCIATIONS_CLUBS","AUTO_DEALER_USED_ONLY","AUTO_RENTALS","AUTO_SERVICE","AUTOMATED_FUEL_DISPENSERS","AUTOMOBILE_ASSOCIATIONS","AUTOMOTIVE","AUTOMOTIVE_REPAIR_SHOPS_NON_DEALER","AUTOMOTIVE_TOP_AND_BODY_SHOPS","AVIATION","BABIES_CLOTHING_AND_SUPPLIES","BABY","BANDS_ORCHESTRAS_ENTERTAINERS","BARBIES","BATH_AND_BODY","BATTERIES","BEAN_BABIES","BEAUTY","BEAUTY_AND_FRAGRANCES","BED_AND_BATH","BICYCLE_SHOPS_SALES_AND_SERVICE","BICYCLES_AND_ACCESSORIES","BILLIARD_POOL_ESTABLISHMENTS","BOAT_DEALERS","BOAT_RENTALS_AND_LEASING","BOATING_SAILING_AND_ACCESSORIES","BOOKS","BOOKS_AND_MAGAZINES","BOOKS_MANUSCRIPTS","BOOKS_PERIODICALS_AND_NEWSPAPERS","BOWLING_ALLEYS","BULLETIN_BOARD","BUS_LINE","BUS_LINES_CHARTERS_TOUR_BUSES","BUSINESS","BUSINESS_AND_SECRETARIAL_SCHOOLS","BUYING_AND_SHOPPING_SERVICES_AND_CLUBS","CABLE_SATELLITE_AND_OTHER_PAY_TELEVISION_AND_RADIO_SERVICES","CABLE_SATELLITE_AND_OTHER_PAY_TV_AND_RADIO","CAMERA_AND_PHOTOGRAPHIC_SUPPLIES","CAMERAS","CAMERAS_AND_PHOTOGRAPHY","CAMPER_RECREATIONAL_AND_UTILITY_TRAILER_DEALERS","CAMPING_AND_OUTDOORS","CAMPING_AND_SURVIVAL","CAR_AND_TRUCK_DEALERS","CAR_AND_TRUCK_DEALERS_USED_ONLY","CAR_AUDIO_AND_ELECTRONICS","CAR_RENTAL_AGENCY","CATALOG_MERCHANT","CATALOG_RETAIL_MERCHANT","CATERING_SERVICES","CHARITY","CHECK_CASHIER","CHILD_CARE_SERVICES","CHILDREN_BOOKS","CHIROPODISTS_PODIATRISTS","CHIROPRACTORS","CIGAR_STORES_AND_STANDS","CIVIC_SOCIAL_FRATERNAL_ASSOCIATIONS","CIVIL_SOCIAL_FRAT_ASSOCIATIONS","CLOTHING","CLOTHING_ACCESSORIES_AND_SHOES","CLOTHING_RENTAL","COFFEE_AND_TEA","COIN_OPERATED_BANKS_AND_CASINOS","COLLECTIBLES","COLLECTION_AGENCY","COLLEGES_AND_UNIVERSITIES","COMMERCIAL_EQUIPMENT","COMMERCIAL_FOOTWEAR","COMMERCIAL_PHOTOGRAPHY","COMMERCIAL_PHOTOGRAPHY_ART_AND_GRAPHICS","COMMERCIAL_SPORTS_PROFESSIONA","COMMODITIES_AND_FUTURES_EXCHANGE","COMPUTER_AND_DATA_PROCESSING_SERVICES","COMPUTER_HARDWARE_AND_SOFTWARE","COMPUTER_MAINTENANCE_REPAIR_AND_SERVICES_NOT_ELSEWHERE_CLAS","CONSTRUCTION","CONSTRUCTION_MATERIALS_NOT_ELSEWHERE_CLASSIFIED","CONSULTING_SERVICES","CONSUMER_CREDIT_REPORTING_AGENCIES","CONVALESCENT_HOMES","COSMETIC_STORES","COUNSELING_SERVICES_DEBT_MARRIAGE_PERSONAL","COUNTERFEIT_CURRENCY_AND_STAMPS","COUNTERFEIT_ITEMS","COUNTRY_CLUBS","COURIER_SERVICES","COURIER_SERVICES_AIR_AND_GROUND_AND_FREIGHT_FORWARDERS","COURT_COSTS_ALIMNY_CHILD_SUPT","COURT_COSTS_INCLUDING_ALIMONY_AND_CHILD_SUPPORT_COURTS_OF_LAW","CREDIT_CARDS","CREDIT_UNION","CULTURE_AND_RELIGION","DAIRY_PRODUCTS_STORES","DANCE_HALLS_STUDIOS_AND_SCHOOLS","DECORATIVE","DENTAL","DENTISTS_AND_ORTHODONTISTS","DEPARTMENT_STORES","DESKTOP_PCS","DEVICES","DIECAST_TOYS_VEHICLES","DIGITAL_GAMES","DIGITAL_MEDIA_BOOKS_MOVIES_MUSIC","DIRECT_MARKETING","DIRECT_MARKETING_CATALOG_MERCHANT","DIRECT_MARKETING_INBOUND_TELE","DIRECT_MARKETING_OUTBOUND_TELE","DIRECT_MARKETING_SUBSCRIPTION","DISCOUNT_STORES","DOOR_TO_DOOR_SALES","DRAPERY_WINDOW_COVERING_AND_UPHOLSTERY","DRINKING_PLACES","DRUGSTORE","DURABLE_GOODS","ECOMMERCE_DEVELOPMENT","ECOMMERCE_SERVICES","EDUCATIONAL_AND_TEXTBOOKS","ELECTRIC_RAZOR_STORES","ELECTRICAL_AND_SMALL_APPLIANCE_REPAIR","ELECTRICAL_CONTRACTORS","ELECTRICAL_PARTS_AND_EQUIPMENT","ELECTRONIC_CASH","ELEMENTARY_AND_SECONDARY_SCHOOLS","EMPLOYMENT","ENTERTAINERS","ENTERTAINMENT_AND_MEDIA","EQUIP_TOOL_FURNITURE_AND_APPLIANCE_RENTAL_AND_LEASING","ESCROW","EVENT_AND_WEDDING_PLANNING","EXERCISE_AND_FITNESS","EXERCISE_EQUIPMENT","EXTERMINATING_AND_DISINFECTING_SERVICES","FABRICS_AND_SEWING","FAMILY_CLOTHING_STORES","FASHION_JEWELRY","FAST_FOOD_RESTAURANTS","FICTION_AND_NONFICTION","FINANCE_COMPANY","FINANCIAL_AND_INVESTMENT_ADVICE","FINANCIAL_INSTITUTIONS_MERCHANDISE_AND_SERVICES","FIREARM_ACCESSORIES","FIREARMS_WEAPONS_AND_KNIVES","FIREPLACE_AND_FIREPLACE_SCREENS","FIREWORKS","FISHING","FLORISTS","FLOWERS","FOOD_DRINK_AND_NUTRITION","FOOD_PRODUCTS","FOOD_RETAIL_AND_SERVICE","FRAGRANCES_AND_PERFUMES","FREEZER_AND_LOCKER_MEAT_PROVISIONERS","FUEL_DEALERS_FUEL_OIL_WOOD_AND_COAL","FUEL_DEALERS_NON_AUTOMOTIVE","FUNERAL_SERVICES_AND_CREMATORIES","FURNISHING_AND_DECORATING","FURNITURE","FURRIERS_AND_FUR_SHOPS","GADGETS_AND_OTHER_ELECTRONICS","GAMBLING","GAME_SOFTWARE","GAMES","GARDEN_SUPPLIES","GENERAL","GENERAL_CONTRACTORS","GENERAL_GOVERNMENT","GENERAL_SOFTWARE","GENERAL_TELECOM","GIFTS_AND_FLOWERS","GLASS_PAINT_AND_WALLPAPER_STORES","GLASSWARE_CRYSTAL_STORES","GOVERNMENT","GOVERNMENT_IDS_AND_LICENSES","GOVERNMENT_LICENSED_ON_LINE_CASINOS_ON_LINE_GAMBLING","GOVERNMENT_OWNED_LOTTERIES","GOVERNMENT_SERVICES","GRAPHIC_AND_COMMERCIAL_DESIGN","GREETING_CARDS","GROCERY_STORES_AND_SUPERMARKETS","HARDWARE_AND_TOOLS","HARDWARE_EQUIPMENT_AND_SUPPLIES","HAZARDOUS_RESTRICTED_AND_PERISHABLE_ITEMS","HEALTH_AND_BEAUTY_SPAS","HEALTH_AND_NUTRITION","HEALTH_AND_PERSONAL_CARE","HEARING_AIDS_SALES_AND_SUPPLIES","HEATING_PLUMBING_AC","HIGH_RISK_MERCHANT","HIRING_SERVICES","HOBBIES_TOYS_AND_GAMES","HOME_AND_GARDEN","HOME_AUDIO","HOME_DECOR","HOME_ELECTRONICS","HOSPITALS","HOTELS_MOTELS_INNS_RESORTS","HOUSEWARES","HUMAN_PARTS_AND_REMAINS","HUMOROUS_GIFTS_AND_NOVELTIES","HUNTING","IDS_LICENSES_AND_PASSPORTS","ILLEGAL_DRUGS_AND_PARAPHERNALIA","INDUSTRIAL","INDUSTRIAL_AND_MANUFACTURING_SUPPLIES","INSURANCE_AUTO_AND_HOME","INSURANCE_DIRECT","INSURANCE_LIFE_AND_ANNUITY","INSURANCE_SALES_UNDERWRITING","INSURANCE_UNDERWRITING_PREMIUMS","INTERNET_AND_NETWORK_SERVICES","INTRA_COMPANY_PURCHASES","LABORATORIES_DENTAL_MEDICAL","LANDSCAPING","LANDSCAPING_AND_HORTICULTURAL_SERVICES","LAUNDRY_CLEANING_SERVICES","LEGAL","LEGAL_SERVICES_AND_ATTORNEYS","LOCAL_DELIVERY_SERVICE","LOCKSMITH","LODGING_AND_ACCOMMODATIONS","LOTTERY_AND_CONTESTS","LUGGAGE_AND_LEATHER_GOODS","LUMBER_AND_BUILDING_MATERIALS","MAGAZINES","MAINTENANCE_AND_REPAIR_SERVICES","MAKEUP_AND_COSMETICS","MANUAL_CASH_DISBURSEMENTS","MASSAGE_PARLORS","MEDICAL","MEDICAL_AND_PHARMACEUTICAL","MEDICAL_CARE","MEDICAL_EQUIPMENT_AND_SUPPLIES","MEDICAL_SERVICES","MEETING_PLANNERS","MEMBERSHIP_CLUBS_AND_ORGANIZATIONS","MEMBERSHIP_COUNTRY_CLUBS_GOLF","MEMORABILIA","MEN_AND_BOY_CLOTHING_AND_ACCESSORY_STORES","MEN_CLOTHING","MERCHANDISE","METAPHYSICAL","MILITARIA","MILITARY_AND_CIVIL_SERVICE_UNIFORMS","MISC","MISCELLANEOUS_GENERAL_SERVICES","MISCELLANEOUS_REPAIR_SHOPS_AND_RELATED_SERVICES","MODEL_KITS","MONEY_TRANSFER_MEMBER_FINANCIAL_INSTITUTION","MONEY_TRANSFER_MERCHANT","MOTION_PICTURE_THEATERS","MOTOR_FREIGHT_CARRIERS_AND_TRUCKING","MOTOR_HOME_AND_RECREATIONAL_VEHICLE_RENTAL","MOTOR_HOMES_DEALERS","MOTOR_VEHICLE_SUPPLIES_AND_NEW_PARTS","MOTORCYCLE_DEALERS","MOTORCYCLES","MOVIE","MOVIE_TICKETS","MOVING_AND_STORAGE","MULTI_LEVEL_MARKETING","MUSIC_CDS_CASSETTES_AND_ALBUMS","MUSIC_STORE_INSTRUMENTS_AND_SHEET_MUSIC","NETWORKING","NEW_AGE","NEW_PARTS_AND_SUPPLIES_MOTOR_VEHICLE","NEWS_DEALERS_AND_NEWSTANDS","NON_DURABLE_GOODS","NON_FICTION","NON_PROFIT_POLITICAL_AND_RELIGION","NONPROFIT","NOVELTIES","OEM_SOFTWARE","OFFICE_SUPPLIES_AND_EQUIPMENT","ONLINE_DATING","ONLINE_GAMING","ONLINE_GAMING_CURRENCY","ONLINE_SERVICES","OOUTBOUND_TELEMARKETING_MERCH","OPHTHALMOLOGISTS_OPTOMETRIST","OPTICIANS_AND_DISPENSING","ORTHOPEDIC_GOODS_PROSTHETICS","OSTEOPATHS","OTHER","PACKAGE_TOUR_OPERATORS","PAINTBALL","PAINTS_VARNISHES_AND_SUPPLIES","PARKING_LOTS_AND_GARAGES","PARTS_AND_ACCESSORIES","PAWN_SHOPS","PAYCHECK_LENDER_OR_CASH_ADVANCE","PERIPHERALS","PERSONALIZED_GIFTS","PET_SHOPS_PET_FOOD_AND_SUPPLIES","PETROLEUM_AND_PETROLEUM_PRODUCTS","PETS_AND_ANIMALS","PHOTOFINISHING_LABORATORIES_PHOTO_DEVELOPING","PHOTOGRAPHIC_STUDIOS_PORTRAITS","PHOTOGRAPHY","PHYSICAL_GOOD","PICTURE_VIDEO_PRODUCTION","PIECE_GOODS_NOTIONS_AND_OTHER_DRY_GOODS","PLANTS_AND_SEEDS","PLUMBING_AND_HEATING_EQUIPMENTS_AND_SUPPLIES","POLICE_RELATED_ITEMS","POLITICAL_ORGANIZATIONS","POSTAL_SERVICES_GOVERNMENT_ONLY","POSTERS","PREPAID_AND_STORED_VALUE_CARDS","PRESCRIPTION_DRUGS","PROMOTIONAL_ITEMS","PUBLIC_WAREHOUSING_AND_STORAGE","PUBLISHING_AND_PRINTING","PUBLISHING_SERVICES","RADAR_DECTORS","RADIO_TELEVISION_AND_STEREO_REPAIR","REAL_ESTATE","REAL_ESTATE_AGENT","REAL_ESTATE_AGENTS_AND_MANAGERS_RENTALS","RELIGION_AND_SPIRITUALITY_FOR_PROFIT","RELIGIOUS","RELIGIOUS_ORGANIZATIONS","REMITTANCE","RENTAL_PROPERTY_MANAGEMENT","RESIDENTIAL","RETAIL","RETAIL_FINE_JEWELRY_AND_WATCHES","REUPHOLSTERY_AND_FURNITURE_REPAIR","RINGS","ROOFING_SIDING_SHEET_METAL","RUGS_AND_CARPETS","SCHOOLS_AND_COLLEGES","SCIENCE_FICTION","SCRAPBOOKING","SCULPTURES","SECURITIES_BROKERS_AND_DEALERS","SECURITY_AND_SURVEILLANCE","SECURITY_AND_SURVEILLANCE_EQUIPMENT","SECURITY_BROKERS_AND_DEALERS","SEMINARS","SERVICE_STATIONS","SERVICES","SEWING_NEEDLEWORK_FABRIC_AND_PIECE_GOODS_STORES","SHIPPING_AND_PACKING","SHOE_REPAIR_HAT_CLEANING","SHOE_STORES","SHOES","SNOWMOBILE_DEALERS","SOFTWARE","SPECIALTY_AND_MISC","SPECIALTY_CLEANING_POLISHING_AND_SANITATION_PREPARATIONS","SPECIALTY_OR_RARE_PETS","SPORT_GAMES_AND_TOYS","SPORTING_AND_RECREATIONAL_CAMPS","SPORTING_GOODS","SPORTS_AND_OUTDOORS","SPORTS_AND_RECREATION","STAMP_AND_COIN","STATIONARY_PRINTING_AND_WRITING_PAPER","STENOGRAPHIC_AND_SECRETARIAL_SUPPORT_SERVICES","STOCKS_BONDS_SECURITIES_AND_RELATED_CERTIFICATES","STORED_VALUE_CARDS","SUPPLIES","SUPPLIES_AND_TOYS","SURVEILLANCE_EQUIPMENT","SWIMMING_POOLS_AND_SPAS","SWIMMING_POOLS_SALES_SUPPLIES_SERVICES","TAILORS_AND_ALTERATIONS","TAX_PAYMENTS","TAX_PAYMENTS_GOVERNMENT_AGENCIES","TAXICABS_AND_LIMOUSINES","TELECOMMUNICATION_SERVICES","TELEPHONE_CARDS","TELEPHONE_EQUIPMENT","TELEPHONE_SERVICES","THEATER","TIRE_RETREADING_AND_REPAIR","TOLL_OR_BRIDGE_FEES","TOOLS_AND_EQUIPMENT","TOURIST_ATTRACTIONS_AND_EXHIBITS","TOWING_SERVICE","TOYS_AND_GAMES","TRADE_AND_VOCATIONAL_SCHOOLS","TRADEMARK_INFRINGEMENT","TRAILER_PARKS_AND_CAMPGROUNDS","TRAINING_SERVICES","TRANSPORTATION_SERVICES","TRAVEL","TRUCK_AND_UTILITY_TRAILER_RENTALS","TRUCK_STOP","TYPESETTING_PLATE_MAKING_AND_RELATED_SERVICES","USED_MERCHANDISE_AND_SECONDHAND_STORES","USED_PARTS_MOTOR_VEHICLE","UTILITIES","UTILITIES_ELECTRIC_GAS_WATER_SANITARY","VARIETY_STORES","VEHICLE_SALES","VEHICLE_SERVICE_AND_ACCESSORIES","VIDEO_EQUIPMENT","VIDEO_GAME_ARCADES_ESTABLISH","VIDEO_GAMES_AND_SYSTEMS","VIDEO_TAPE_RENTAL_STORES","VINTAGE_AND_COLLECTIBLE_VEHICLES","VINTAGE_AND_COLLECTIBLES","VITAMINS_AND_SUPPLEMENTS","VOCATIONAL_AND_TRADE_SCHOOLS","WATCH_CLOCK_AND_JEWELRY_REPAIR","WEB_HOSTING_AND_DESIGN","WELDING_REPAIR","WHOLESALE_CLUBS","WHOLESALE_FLORIST_SUPPLIERS","WHOLESALE_PRESCRIPTION_DRUGS","WILDLIFE_PRODUCTS","WIRE_TRANSFER","WIRE_TRANSFER_AND_MONEY_ORDER","WOMEN_ACCESSORY_SPECIALITY","WOMEN_CLOTHING"]},"createdAt":{"type":"string","description":"Product creation date (ISO-8601)","format":"date"},"updatedAt":{"type":"string","description":"Product last update date (ISO-8601)","format":"date"},"imageUrl":{"maxLength":2000,"minLength":1,"type":"string","description":"The home page URL for the product"},"homeUrl":{"maxLength":2000,"minLength":1,"type":"string","description":"The image URL for the product"}}}}}}
```

## The products object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"products":{"type":"array","items":{"$ref":"#/components/schemas/Model6"}},"Model6":{"required":["createdAt","name","type","updatedAt"],"type":"object","properties":{"id":{"maxLength":50,"minLength":6,"type":"string","description":"The ID of the product. You can specify the SKU for the product. If you omit the ID, the system generates it. System-generated IDs have the PROD- prefix"},"name":{"maxLength":127,"minLength":1,"type":"string","description":"The product name"},"description":{"maxLength":256,"minLength":1,"type":"string","description":"The product description"},"type":{"type":"string","description":"The product type. Indicates whether the product is physical or tangible goods, or a service","enum":["PHYSICAL","DIGITAL","SERVICE"]},"category":{"type":"string","description":"The product category","enum":["AC_REFRIGERATION_REPAIR","ACADEMIC_SOFTWARE","ACCESSORIES","ACCOUNTING","ADULT","ADVERTISING","AFFILIATED_AUTO_RENTAL","AGENCIES","AGGREGATORS","AGRICULTURAL_COOPERATIVE_FOR_MAIL_ORDER","AIR_CARRIERS_AIRLINES","AIRLINES","AIRPORTS_FLYING_FIELDS","ALCOHOLIC_BEVERAGES","AMUSEMENT_PARKS_CARNIVALS","ANIMATION","ANTIQUES","APPLIANCES","AQUARIAMS_SEAQUARIUMS_DOLPHINARIUMS","ARCHITECTURAL_ENGINEERING_AND_SURVEYING_SERVICES","ART_AND_CRAFT_SUPPLIES","ART_DEALERS_AND_GALLERIES","ARTIFACTS_GRAVE_RELATED_AND_NATIVE_AMERICAN_CRAFTS","ARTS_AND_CRAFTS","ARTS_CRAFTS_AND_COLLECTIBLES","AUDIO_BOOKS","AUTO_ASSOCIATIONS_CLUBS","AUTO_DEALER_USED_ONLY","AUTO_RENTALS","AUTO_SERVICE","AUTOMATED_FUEL_DISPENSERS","AUTOMOBILE_ASSOCIATIONS","AUTOMOTIVE","AUTOMOTIVE_REPAIR_SHOPS_NON_DEALER","AUTOMOTIVE_TOP_AND_BODY_SHOPS","AVIATION","BABIES_CLOTHING_AND_SUPPLIES","BABY","BANDS_ORCHESTRAS_ENTERTAINERS","BARBIES","BATH_AND_BODY","BATTERIES","BEAN_BABIES","BEAUTY","BEAUTY_AND_FRAGRANCES","BED_AND_BATH","BICYCLE_SHOPS_SALES_AND_SERVICE","BICYCLES_AND_ACCESSORIES","BILLIARD_POOL_ESTABLISHMENTS","BOAT_DEALERS","BOAT_RENTALS_AND_LEASING","BOATING_SAILING_AND_ACCESSORIES","BOOKS","BOOKS_AND_MAGAZINES","BOOKS_MANUSCRIPTS","BOOKS_PERIODICALS_AND_NEWSPAPERS","BOWLING_ALLEYS","BULLETIN_BOARD","BUS_LINE","BUS_LINES_CHARTERS_TOUR_BUSES","BUSINESS","BUSINESS_AND_SECRETARIAL_SCHOOLS","BUYING_AND_SHOPPING_SERVICES_AND_CLUBS","CABLE_SATELLITE_AND_OTHER_PAY_TELEVISION_AND_RADIO_SERVICES","CABLE_SATELLITE_AND_OTHER_PAY_TV_AND_RADIO","CAMERA_AND_PHOTOGRAPHIC_SUPPLIES","CAMERAS","CAMERAS_AND_PHOTOGRAPHY","CAMPER_RECREATIONAL_AND_UTILITY_TRAILER_DEALERS","CAMPING_AND_OUTDOORS","CAMPING_AND_SURVIVAL","CAR_AND_TRUCK_DEALERS","CAR_AND_TRUCK_DEALERS_USED_ONLY","CAR_AUDIO_AND_ELECTRONICS","CAR_RENTAL_AGENCY","CATALOG_MERCHANT","CATALOG_RETAIL_MERCHANT","CATERING_SERVICES","CHARITY","CHECK_CASHIER","CHILD_CARE_SERVICES","CHILDREN_BOOKS","CHIROPODISTS_PODIATRISTS","CHIROPRACTORS","CIGAR_STORES_AND_STANDS","CIVIC_SOCIAL_FRATERNAL_ASSOCIATIONS","CIVIL_SOCIAL_FRAT_ASSOCIATIONS","CLOTHING","CLOTHING_ACCESSORIES_AND_SHOES","CLOTHING_RENTAL","COFFEE_AND_TEA","COIN_OPERATED_BANKS_AND_CASINOS","COLLECTIBLES","COLLECTION_AGENCY","COLLEGES_AND_UNIVERSITIES","COMMERCIAL_EQUIPMENT","COMMERCIAL_FOOTWEAR","COMMERCIAL_PHOTOGRAPHY","COMMERCIAL_PHOTOGRAPHY_ART_AND_GRAPHICS","COMMERCIAL_SPORTS_PROFESSIONA","COMMODITIES_AND_FUTURES_EXCHANGE","COMPUTER_AND_DATA_PROCESSING_SERVICES","COMPUTER_HARDWARE_AND_SOFTWARE","COMPUTER_MAINTENANCE_REPAIR_AND_SERVICES_NOT_ELSEWHERE_CLAS","CONSTRUCTION","CONSTRUCTION_MATERIALS_NOT_ELSEWHERE_CLASSIFIED","CONSULTING_SERVICES","CONSUMER_CREDIT_REPORTING_AGENCIES","CONVALESCENT_HOMES","COSMETIC_STORES","COUNSELING_SERVICES_DEBT_MARRIAGE_PERSONAL","COUNTERFEIT_CURRENCY_AND_STAMPS","COUNTERFEIT_ITEMS","COUNTRY_CLUBS","COURIER_SERVICES","COURIER_SERVICES_AIR_AND_GROUND_AND_FREIGHT_FORWARDERS","COURT_COSTS_ALIMNY_CHILD_SUPT","COURT_COSTS_INCLUDING_ALIMONY_AND_CHILD_SUPPORT_COURTS_OF_LAW","CREDIT_CARDS","CREDIT_UNION","CULTURE_AND_RELIGION","DAIRY_PRODUCTS_STORES","DANCE_HALLS_STUDIOS_AND_SCHOOLS","DECORATIVE","DENTAL","DENTISTS_AND_ORTHODONTISTS","DEPARTMENT_STORES","DESKTOP_PCS","DEVICES","DIECAST_TOYS_VEHICLES","DIGITAL_GAMES","DIGITAL_MEDIA_BOOKS_MOVIES_MUSIC","DIRECT_MARKETING","DIRECT_MARKETING_CATALOG_MERCHANT","DIRECT_MARKETING_INBOUND_TELE","DIRECT_MARKETING_OUTBOUND_TELE","DIRECT_MARKETING_SUBSCRIPTION","DISCOUNT_STORES","DOOR_TO_DOOR_SALES","DRAPERY_WINDOW_COVERING_AND_UPHOLSTERY","DRINKING_PLACES","DRUGSTORE","DURABLE_GOODS","ECOMMERCE_DEVELOPMENT","ECOMMERCE_SERVICES","EDUCATIONAL_AND_TEXTBOOKS","ELECTRIC_RAZOR_STORES","ELECTRICAL_AND_SMALL_APPLIANCE_REPAIR","ELECTRICAL_CONTRACTORS","ELECTRICAL_PARTS_AND_EQUIPMENT","ELECTRONIC_CASH","ELEMENTARY_AND_SECONDARY_SCHOOLS","EMPLOYMENT","ENTERTAINERS","ENTERTAINMENT_AND_MEDIA","EQUIP_TOOL_FURNITURE_AND_APPLIANCE_RENTAL_AND_LEASING","ESCROW","EVENT_AND_WEDDING_PLANNING","EXERCISE_AND_FITNESS","EXERCISE_EQUIPMENT","EXTERMINATING_AND_DISINFECTING_SERVICES","FABRICS_AND_SEWING","FAMILY_CLOTHING_STORES","FASHION_JEWELRY","FAST_FOOD_RESTAURANTS","FICTION_AND_NONFICTION","FINANCE_COMPANY","FINANCIAL_AND_INVESTMENT_ADVICE","FINANCIAL_INSTITUTIONS_MERCHANDISE_AND_SERVICES","FIREARM_ACCESSORIES","FIREARMS_WEAPONS_AND_KNIVES","FIREPLACE_AND_FIREPLACE_SCREENS","FIREWORKS","FISHING","FLORISTS","FLOWERS","FOOD_DRINK_AND_NUTRITION","FOOD_PRODUCTS","FOOD_RETAIL_AND_SERVICE","FRAGRANCES_AND_PERFUMES","FREEZER_AND_LOCKER_MEAT_PROVISIONERS","FUEL_DEALERS_FUEL_OIL_WOOD_AND_COAL","FUEL_DEALERS_NON_AUTOMOTIVE","FUNERAL_SERVICES_AND_CREMATORIES","FURNISHING_AND_DECORATING","FURNITURE","FURRIERS_AND_FUR_SHOPS","GADGETS_AND_OTHER_ELECTRONICS","GAMBLING","GAME_SOFTWARE","GAMES","GARDEN_SUPPLIES","GENERAL","GENERAL_CONTRACTORS","GENERAL_GOVERNMENT","GENERAL_SOFTWARE","GENERAL_TELECOM","GIFTS_AND_FLOWERS","GLASS_PAINT_AND_WALLPAPER_STORES","GLASSWARE_CRYSTAL_STORES","GOVERNMENT","GOVERNMENT_IDS_AND_LICENSES","GOVERNMENT_LICENSED_ON_LINE_CASINOS_ON_LINE_GAMBLING","GOVERNMENT_OWNED_LOTTERIES","GOVERNMENT_SERVICES","GRAPHIC_AND_COMMERCIAL_DESIGN","GREETING_CARDS","GROCERY_STORES_AND_SUPERMARKETS","HARDWARE_AND_TOOLS","HARDWARE_EQUIPMENT_AND_SUPPLIES","HAZARDOUS_RESTRICTED_AND_PERISHABLE_ITEMS","HEALTH_AND_BEAUTY_SPAS","HEALTH_AND_NUTRITION","HEALTH_AND_PERSONAL_CARE","HEARING_AIDS_SALES_AND_SUPPLIES","HEATING_PLUMBING_AC","HIGH_RISK_MERCHANT","HIRING_SERVICES","HOBBIES_TOYS_AND_GAMES","HOME_AND_GARDEN","HOME_AUDIO","HOME_DECOR","HOME_ELECTRONICS","HOSPITALS","HOTELS_MOTELS_INNS_RESORTS","HOUSEWARES","HUMAN_PARTS_AND_REMAINS","HUMOROUS_GIFTS_AND_NOVELTIES","HUNTING","IDS_LICENSES_AND_PASSPORTS","ILLEGAL_DRUGS_AND_PARAPHERNALIA","INDUSTRIAL","INDUSTRIAL_AND_MANUFACTURING_SUPPLIES","INSURANCE_AUTO_AND_HOME","INSURANCE_DIRECT","INSURANCE_LIFE_AND_ANNUITY","INSURANCE_SALES_UNDERWRITING","INSURANCE_UNDERWRITING_PREMIUMS","INTERNET_AND_NETWORK_SERVICES","INTRA_COMPANY_PURCHASES","LABORATORIES_DENTAL_MEDICAL","LANDSCAPING","LANDSCAPING_AND_HORTICULTURAL_SERVICES","LAUNDRY_CLEANING_SERVICES","LEGAL","LEGAL_SERVICES_AND_ATTORNEYS","LOCAL_DELIVERY_SERVICE","LOCKSMITH","LODGING_AND_ACCOMMODATIONS","LOTTERY_AND_CONTESTS","LUGGAGE_AND_LEATHER_GOODS","LUMBER_AND_BUILDING_MATERIALS","MAGAZINES","MAINTENANCE_AND_REPAIR_SERVICES","MAKEUP_AND_COSMETICS","MANUAL_CASH_DISBURSEMENTS","MASSAGE_PARLORS","MEDICAL","MEDICAL_AND_PHARMACEUTICAL","MEDICAL_CARE","MEDICAL_EQUIPMENT_AND_SUPPLIES","MEDICAL_SERVICES","MEETING_PLANNERS","MEMBERSHIP_CLUBS_AND_ORGANIZATIONS","MEMBERSHIP_COUNTRY_CLUBS_GOLF","MEMORABILIA","MEN_AND_BOY_CLOTHING_AND_ACCESSORY_STORES","MEN_CLOTHING","MERCHANDISE","METAPHYSICAL","MILITARIA","MILITARY_AND_CIVIL_SERVICE_UNIFORMS","MISC","MISCELLANEOUS_GENERAL_SERVICES","MISCELLANEOUS_REPAIR_SHOPS_AND_RELATED_SERVICES","MODEL_KITS","MONEY_TRANSFER_MEMBER_FINANCIAL_INSTITUTION","MONEY_TRANSFER_MERCHANT","MOTION_PICTURE_THEATERS","MOTOR_FREIGHT_CARRIERS_AND_TRUCKING","MOTOR_HOME_AND_RECREATIONAL_VEHICLE_RENTAL","MOTOR_HOMES_DEALERS","MOTOR_VEHICLE_SUPPLIES_AND_NEW_PARTS","MOTORCYCLE_DEALERS","MOTORCYCLES","MOVIE","MOVIE_TICKETS","MOVING_AND_STORAGE","MULTI_LEVEL_MARKETING","MUSIC_CDS_CASSETTES_AND_ALBUMS","MUSIC_STORE_INSTRUMENTS_AND_SHEET_MUSIC","NETWORKING","NEW_AGE","NEW_PARTS_AND_SUPPLIES_MOTOR_VEHICLE","NEWS_DEALERS_AND_NEWSTANDS","NON_DURABLE_GOODS","NON_FICTION","NON_PROFIT_POLITICAL_AND_RELIGION","NONPROFIT","NOVELTIES","OEM_SOFTWARE","OFFICE_SUPPLIES_AND_EQUIPMENT","ONLINE_DATING","ONLINE_GAMING","ONLINE_GAMING_CURRENCY","ONLINE_SERVICES","OOUTBOUND_TELEMARKETING_MERCH","OPHTHALMOLOGISTS_OPTOMETRIST","OPTICIANS_AND_DISPENSING","ORTHOPEDIC_GOODS_PROSTHETICS","OSTEOPATHS","OTHER","PACKAGE_TOUR_OPERATORS","PAINTBALL","PAINTS_VARNISHES_AND_SUPPLIES","PARKING_LOTS_AND_GARAGES","PARTS_AND_ACCESSORIES","PAWN_SHOPS","PAYCHECK_LENDER_OR_CASH_ADVANCE","PERIPHERALS","PERSONALIZED_GIFTS","PET_SHOPS_PET_FOOD_AND_SUPPLIES","PETROLEUM_AND_PETROLEUM_PRODUCTS","PETS_AND_ANIMALS","PHOTOFINISHING_LABORATORIES_PHOTO_DEVELOPING","PHOTOGRAPHIC_STUDIOS_PORTRAITS","PHOTOGRAPHY","PHYSICAL_GOOD","PICTURE_VIDEO_PRODUCTION","PIECE_GOODS_NOTIONS_AND_OTHER_DRY_GOODS","PLANTS_AND_SEEDS","PLUMBING_AND_HEATING_EQUIPMENTS_AND_SUPPLIES","POLICE_RELATED_ITEMS","POLITICAL_ORGANIZATIONS","POSTAL_SERVICES_GOVERNMENT_ONLY","POSTERS","PREPAID_AND_STORED_VALUE_CARDS","PRESCRIPTION_DRUGS","PROMOTIONAL_ITEMS","PUBLIC_WAREHOUSING_AND_STORAGE","PUBLISHING_AND_PRINTING","PUBLISHING_SERVICES","RADAR_DECTORS","RADIO_TELEVISION_AND_STEREO_REPAIR","REAL_ESTATE","REAL_ESTATE_AGENT","REAL_ESTATE_AGENTS_AND_MANAGERS_RENTALS","RELIGION_AND_SPIRITUALITY_FOR_PROFIT","RELIGIOUS","RELIGIOUS_ORGANIZATIONS","REMITTANCE","RENTAL_PROPERTY_MANAGEMENT","RESIDENTIAL","RETAIL","RETAIL_FINE_JEWELRY_AND_WATCHES","REUPHOLSTERY_AND_FURNITURE_REPAIR","RINGS","ROOFING_SIDING_SHEET_METAL","RUGS_AND_CARPETS","SCHOOLS_AND_COLLEGES","SCIENCE_FICTION","SCRAPBOOKING","SCULPTURES","SECURITIES_BROKERS_AND_DEALERS","SECURITY_AND_SURVEILLANCE","SECURITY_AND_SURVEILLANCE_EQUIPMENT","SECURITY_BROKERS_AND_DEALERS","SEMINARS","SERVICE_STATIONS","SERVICES","SEWING_NEEDLEWORK_FABRIC_AND_PIECE_GOODS_STORES","SHIPPING_AND_PACKING","SHOE_REPAIR_HAT_CLEANING","SHOE_STORES","SHOES","SNOWMOBILE_DEALERS","SOFTWARE","SPECIALTY_AND_MISC","SPECIALTY_CLEANING_POLISHING_AND_SANITATION_PREPARATIONS","SPECIALTY_OR_RARE_PETS","SPORT_GAMES_AND_TOYS","SPORTING_AND_RECREATIONAL_CAMPS","SPORTING_GOODS","SPORTS_AND_OUTDOORS","SPORTS_AND_RECREATION","STAMP_AND_COIN","STATIONARY_PRINTING_AND_WRITING_PAPER","STENOGRAPHIC_AND_SECRETARIAL_SUPPORT_SERVICES","STOCKS_BONDS_SECURITIES_AND_RELATED_CERTIFICATES","STORED_VALUE_CARDS","SUPPLIES","SUPPLIES_AND_TOYS","SURVEILLANCE_EQUIPMENT","SWIMMING_POOLS_AND_SPAS","SWIMMING_POOLS_SALES_SUPPLIES_SERVICES","TAILORS_AND_ALTERATIONS","TAX_PAYMENTS","TAX_PAYMENTS_GOVERNMENT_AGENCIES","TAXICABS_AND_LIMOUSINES","TELECOMMUNICATION_SERVICES","TELEPHONE_CARDS","TELEPHONE_EQUIPMENT","TELEPHONE_SERVICES","THEATER","TIRE_RETREADING_AND_REPAIR","TOLL_OR_BRIDGE_FEES","TOOLS_AND_EQUIPMENT","TOURIST_ATTRACTIONS_AND_EXHIBITS","TOWING_SERVICE","TOYS_AND_GAMES","TRADE_AND_VOCATIONAL_SCHOOLS","TRADEMARK_INFRINGEMENT","TRAILER_PARKS_AND_CAMPGROUNDS","TRAINING_SERVICES","TRANSPORTATION_SERVICES","TRAVEL","TRUCK_AND_UTILITY_TRAILER_RENTALS","TRUCK_STOP","TYPESETTING_PLATE_MAKING_AND_RELATED_SERVICES","USED_MERCHANDISE_AND_SECONDHAND_STORES","USED_PARTS_MOTOR_VEHICLE","UTILITIES","UTILITIES_ELECTRIC_GAS_WATER_SANITARY","VARIETY_STORES","VEHICLE_SALES","VEHICLE_SERVICE_AND_ACCESSORIES","VIDEO_EQUIPMENT","VIDEO_GAME_ARCADES_ESTABLISH","VIDEO_GAMES_AND_SYSTEMS","VIDEO_TAPE_RENTAL_STORES","VINTAGE_AND_COLLECTIBLE_VEHICLES","VINTAGE_AND_COLLECTIBLES","VITAMINS_AND_SUPPLEMENTS","VOCATIONAL_AND_TRADE_SCHOOLS","WATCH_CLOCK_AND_JEWELRY_REPAIR","WEB_HOSTING_AND_DESIGN","WELDING_REPAIR","WHOLESALE_CLUBS","WHOLESALE_FLORIST_SUPPLIERS","WHOLESALE_PRESCRIPTION_DRUGS","WILDLIFE_PRODUCTS","WIRE_TRANSFER","WIRE_TRANSFER_AND_MONEY_ORDER","WOMEN_ACCESSORY_SPECIALITY","WOMEN_CLOTHING"]},"createdAt":{"type":"string","description":"Product creation date (ISO-8601)","format":"date"},"updatedAt":{"type":"string","description":"Product last update date (ISO-8601)","format":"date"},"imageUrl":{"maxLength":2000,"minLength":1,"type":"string","description":"The home page URL for the product"},"homeUrl":{"maxLength":2000,"minLength":1,"type":"string","description":"The image URL for the product"}}}}}}
```

## The Model7 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model7":{"required":["products"],"type":"object","properties":{"totalItems":{"type":"integer"},"totalPages":{"type":"integer"},"products":{"$ref":"#/components/schemas/products"}}},"products":{"type":"array","items":{"$ref":"#/components/schemas/Model6"}},"Model6":{"required":["createdAt","name","type","updatedAt"],"type":"object","properties":{"id":{"maxLength":50,"minLength":6,"type":"string","description":"The ID of the product. You can specify the SKU for the product. If you omit the ID, the system generates it. System-generated IDs have the PROD- prefix"},"name":{"maxLength":127,"minLength":1,"type":"string","description":"The product name"},"description":{"maxLength":256,"minLength":1,"type":"string","description":"The product description"},"type":{"type":"string","description":"The product type. Indicates whether the product is physical or tangible goods, or a service","enum":["PHYSICAL","DIGITAL","SERVICE"]},"category":{"type":"string","description":"The product category","enum":["AC_REFRIGERATION_REPAIR","ACADEMIC_SOFTWARE","ACCESSORIES","ACCOUNTING","ADULT","ADVERTISING","AFFILIATED_AUTO_RENTAL","AGENCIES","AGGREGATORS","AGRICULTURAL_COOPERATIVE_FOR_MAIL_ORDER","AIR_CARRIERS_AIRLINES","AIRLINES","AIRPORTS_FLYING_FIELDS","ALCOHOLIC_BEVERAGES","AMUSEMENT_PARKS_CARNIVALS","ANIMATION","ANTIQUES","APPLIANCES","AQUARIAMS_SEAQUARIUMS_DOLPHINARIUMS","ARCHITECTURAL_ENGINEERING_AND_SURVEYING_SERVICES","ART_AND_CRAFT_SUPPLIES","ART_DEALERS_AND_GALLERIES","ARTIFACTS_GRAVE_RELATED_AND_NATIVE_AMERICAN_CRAFTS","ARTS_AND_CRAFTS","ARTS_CRAFTS_AND_COLLECTIBLES","AUDIO_BOOKS","AUTO_ASSOCIATIONS_CLUBS","AUTO_DEALER_USED_ONLY","AUTO_RENTALS","AUTO_SERVICE","AUTOMATED_FUEL_DISPENSERS","AUTOMOBILE_ASSOCIATIONS","AUTOMOTIVE","AUTOMOTIVE_REPAIR_SHOPS_NON_DEALER","AUTOMOTIVE_TOP_AND_BODY_SHOPS","AVIATION","BABIES_CLOTHING_AND_SUPPLIES","BABY","BANDS_ORCHESTRAS_ENTERTAINERS","BARBIES","BATH_AND_BODY","BATTERIES","BEAN_BABIES","BEAUTY","BEAUTY_AND_FRAGRANCES","BED_AND_BATH","BICYCLE_SHOPS_SALES_AND_SERVICE","BICYCLES_AND_ACCESSORIES","BILLIARD_POOL_ESTABLISHMENTS","BOAT_DEALERS","BOAT_RENTALS_AND_LEASING","BOATING_SAILING_AND_ACCESSORIES","BOOKS","BOOKS_AND_MAGAZINES","BOOKS_MANUSCRIPTS","BOOKS_PERIODICALS_AND_NEWSPAPERS","BOWLING_ALLEYS","BULLETIN_BOARD","BUS_LINE","BUS_LINES_CHARTERS_TOUR_BUSES","BUSINESS","BUSINESS_AND_SECRETARIAL_SCHOOLS","BUYING_AND_SHOPPING_SERVICES_AND_CLUBS","CABLE_SATELLITE_AND_OTHER_PAY_TELEVISION_AND_RADIO_SERVICES","CABLE_SATELLITE_AND_OTHER_PAY_TV_AND_RADIO","CAMERA_AND_PHOTOGRAPHIC_SUPPLIES","CAMERAS","CAMERAS_AND_PHOTOGRAPHY","CAMPER_RECREATIONAL_AND_UTILITY_TRAILER_DEALERS","CAMPING_AND_OUTDOORS","CAMPING_AND_SURVIVAL","CAR_AND_TRUCK_DEALERS","CAR_AND_TRUCK_DEALERS_USED_ONLY","CAR_AUDIO_AND_ELECTRONICS","CAR_RENTAL_AGENCY","CATALOG_MERCHANT","CATALOG_RETAIL_MERCHANT","CATERING_SERVICES","CHARITY","CHECK_CASHIER","CHILD_CARE_SERVICES","CHILDREN_BOOKS","CHIROPODISTS_PODIATRISTS","CHIROPRACTORS","CIGAR_STORES_AND_STANDS","CIVIC_SOCIAL_FRATERNAL_ASSOCIATIONS","CIVIL_SOCIAL_FRAT_ASSOCIATIONS","CLOTHING","CLOTHING_ACCESSORIES_AND_SHOES","CLOTHING_RENTAL","COFFEE_AND_TEA","COIN_OPERATED_BANKS_AND_CASINOS","COLLECTIBLES","COLLECTION_AGENCY","COLLEGES_AND_UNIVERSITIES","COMMERCIAL_EQUIPMENT","COMMERCIAL_FOOTWEAR","COMMERCIAL_PHOTOGRAPHY","COMMERCIAL_PHOTOGRAPHY_ART_AND_GRAPHICS","COMMERCIAL_SPORTS_PROFESSIONA","COMMODITIES_AND_FUTURES_EXCHANGE","COMPUTER_AND_DATA_PROCESSING_SERVICES","COMPUTER_HARDWARE_AND_SOFTWARE","COMPUTER_MAINTENANCE_REPAIR_AND_SERVICES_NOT_ELSEWHERE_CLAS","CONSTRUCTION","CONSTRUCTION_MATERIALS_NOT_ELSEWHERE_CLASSIFIED","CONSULTING_SERVICES","CONSUMER_CREDIT_REPORTING_AGENCIES","CONVALESCENT_HOMES","COSMETIC_STORES","COUNSELING_SERVICES_DEBT_MARRIAGE_PERSONAL","COUNTERFEIT_CURRENCY_AND_STAMPS","COUNTERFEIT_ITEMS","COUNTRY_CLUBS","COURIER_SERVICES","COURIER_SERVICES_AIR_AND_GROUND_AND_FREIGHT_FORWARDERS","COURT_COSTS_ALIMNY_CHILD_SUPT","COURT_COSTS_INCLUDING_ALIMONY_AND_CHILD_SUPPORT_COURTS_OF_LAW","CREDIT_CARDS","CREDIT_UNION","CULTURE_AND_RELIGION","DAIRY_PRODUCTS_STORES","DANCE_HALLS_STUDIOS_AND_SCHOOLS","DECORATIVE","DENTAL","DENTISTS_AND_ORTHODONTISTS","DEPARTMENT_STORES","DESKTOP_PCS","DEVICES","DIECAST_TOYS_VEHICLES","DIGITAL_GAMES","DIGITAL_MEDIA_BOOKS_MOVIES_MUSIC","DIRECT_MARKETING","DIRECT_MARKETING_CATALOG_MERCHANT","DIRECT_MARKETING_INBOUND_TELE","DIRECT_MARKETING_OUTBOUND_TELE","DIRECT_MARKETING_SUBSCRIPTION","DISCOUNT_STORES","DOOR_TO_DOOR_SALES","DRAPERY_WINDOW_COVERING_AND_UPHOLSTERY","DRINKING_PLACES","DRUGSTORE","DURABLE_GOODS","ECOMMERCE_DEVELOPMENT","ECOMMERCE_SERVICES","EDUCATIONAL_AND_TEXTBOOKS","ELECTRIC_RAZOR_STORES","ELECTRICAL_AND_SMALL_APPLIANCE_REPAIR","ELECTRICAL_CONTRACTORS","ELECTRICAL_PARTS_AND_EQUIPMENT","ELECTRONIC_CASH","ELEMENTARY_AND_SECONDARY_SCHOOLS","EMPLOYMENT","ENTERTAINERS","ENTERTAINMENT_AND_MEDIA","EQUIP_TOOL_FURNITURE_AND_APPLIANCE_RENTAL_AND_LEASING","ESCROW","EVENT_AND_WEDDING_PLANNING","EXERCISE_AND_FITNESS","EXERCISE_EQUIPMENT","EXTERMINATING_AND_DISINFECTING_SERVICES","FABRICS_AND_SEWING","FAMILY_CLOTHING_STORES","FASHION_JEWELRY","FAST_FOOD_RESTAURANTS","FICTION_AND_NONFICTION","FINANCE_COMPANY","FINANCIAL_AND_INVESTMENT_ADVICE","FINANCIAL_INSTITUTIONS_MERCHANDISE_AND_SERVICES","FIREARM_ACCESSORIES","FIREARMS_WEAPONS_AND_KNIVES","FIREPLACE_AND_FIREPLACE_SCREENS","FIREWORKS","FISHING","FLORISTS","FLOWERS","FOOD_DRINK_AND_NUTRITION","FOOD_PRODUCTS","FOOD_RETAIL_AND_SERVICE","FRAGRANCES_AND_PERFUMES","FREEZER_AND_LOCKER_MEAT_PROVISIONERS","FUEL_DEALERS_FUEL_OIL_WOOD_AND_COAL","FUEL_DEALERS_NON_AUTOMOTIVE","FUNERAL_SERVICES_AND_CREMATORIES","FURNISHING_AND_DECORATING","FURNITURE","FURRIERS_AND_FUR_SHOPS","GADGETS_AND_OTHER_ELECTRONICS","GAMBLING","GAME_SOFTWARE","GAMES","GARDEN_SUPPLIES","GENERAL","GENERAL_CONTRACTORS","GENERAL_GOVERNMENT","GENERAL_SOFTWARE","GENERAL_TELECOM","GIFTS_AND_FLOWERS","GLASS_PAINT_AND_WALLPAPER_STORES","GLASSWARE_CRYSTAL_STORES","GOVERNMENT","GOVERNMENT_IDS_AND_LICENSES","GOVERNMENT_LICENSED_ON_LINE_CASINOS_ON_LINE_GAMBLING","GOVERNMENT_OWNED_LOTTERIES","GOVERNMENT_SERVICES","GRAPHIC_AND_COMMERCIAL_DESIGN","GREETING_CARDS","GROCERY_STORES_AND_SUPERMARKETS","HARDWARE_AND_TOOLS","HARDWARE_EQUIPMENT_AND_SUPPLIES","HAZARDOUS_RESTRICTED_AND_PERISHABLE_ITEMS","HEALTH_AND_BEAUTY_SPAS","HEALTH_AND_NUTRITION","HEALTH_AND_PERSONAL_CARE","HEARING_AIDS_SALES_AND_SUPPLIES","HEATING_PLUMBING_AC","HIGH_RISK_MERCHANT","HIRING_SERVICES","HOBBIES_TOYS_AND_GAMES","HOME_AND_GARDEN","HOME_AUDIO","HOME_DECOR","HOME_ELECTRONICS","HOSPITALS","HOTELS_MOTELS_INNS_RESORTS","HOUSEWARES","HUMAN_PARTS_AND_REMAINS","HUMOROUS_GIFTS_AND_NOVELTIES","HUNTING","IDS_LICENSES_AND_PASSPORTS","ILLEGAL_DRUGS_AND_PARAPHERNALIA","INDUSTRIAL","INDUSTRIAL_AND_MANUFACTURING_SUPPLIES","INSURANCE_AUTO_AND_HOME","INSURANCE_DIRECT","INSURANCE_LIFE_AND_ANNUITY","INSURANCE_SALES_UNDERWRITING","INSURANCE_UNDERWRITING_PREMIUMS","INTERNET_AND_NETWORK_SERVICES","INTRA_COMPANY_PURCHASES","LABORATORIES_DENTAL_MEDICAL","LANDSCAPING","LANDSCAPING_AND_HORTICULTURAL_SERVICES","LAUNDRY_CLEANING_SERVICES","LEGAL","LEGAL_SERVICES_AND_ATTORNEYS","LOCAL_DELIVERY_SERVICE","LOCKSMITH","LODGING_AND_ACCOMMODATIONS","LOTTERY_AND_CONTESTS","LUGGAGE_AND_LEATHER_GOODS","LUMBER_AND_BUILDING_MATERIALS","MAGAZINES","MAINTENANCE_AND_REPAIR_SERVICES","MAKEUP_AND_COSMETICS","MANUAL_CASH_DISBURSEMENTS","MASSAGE_PARLORS","MEDICAL","MEDICAL_AND_PHARMACEUTICAL","MEDICAL_CARE","MEDICAL_EQUIPMENT_AND_SUPPLIES","MEDICAL_SERVICES","MEETING_PLANNERS","MEMBERSHIP_CLUBS_AND_ORGANIZATIONS","MEMBERSHIP_COUNTRY_CLUBS_GOLF","MEMORABILIA","MEN_AND_BOY_CLOTHING_AND_ACCESSORY_STORES","MEN_CLOTHING","MERCHANDISE","METAPHYSICAL","MILITARIA","MILITARY_AND_CIVIL_SERVICE_UNIFORMS","MISC","MISCELLANEOUS_GENERAL_SERVICES","MISCELLANEOUS_REPAIR_SHOPS_AND_RELATED_SERVICES","MODEL_KITS","MONEY_TRANSFER_MEMBER_FINANCIAL_INSTITUTION","MONEY_TRANSFER_MERCHANT","MOTION_PICTURE_THEATERS","MOTOR_FREIGHT_CARRIERS_AND_TRUCKING","MOTOR_HOME_AND_RECREATIONAL_VEHICLE_RENTAL","MOTOR_HOMES_DEALERS","MOTOR_VEHICLE_SUPPLIES_AND_NEW_PARTS","MOTORCYCLE_DEALERS","MOTORCYCLES","MOVIE","MOVIE_TICKETS","MOVING_AND_STORAGE","MULTI_LEVEL_MARKETING","MUSIC_CDS_CASSETTES_AND_ALBUMS","MUSIC_STORE_INSTRUMENTS_AND_SHEET_MUSIC","NETWORKING","NEW_AGE","NEW_PARTS_AND_SUPPLIES_MOTOR_VEHICLE","NEWS_DEALERS_AND_NEWSTANDS","NON_DURABLE_GOODS","NON_FICTION","NON_PROFIT_POLITICAL_AND_RELIGION","NONPROFIT","NOVELTIES","OEM_SOFTWARE","OFFICE_SUPPLIES_AND_EQUIPMENT","ONLINE_DATING","ONLINE_GAMING","ONLINE_GAMING_CURRENCY","ONLINE_SERVICES","OOUTBOUND_TELEMARKETING_MERCH","OPHTHALMOLOGISTS_OPTOMETRIST","OPTICIANS_AND_DISPENSING","ORTHOPEDIC_GOODS_PROSTHETICS","OSTEOPATHS","OTHER","PACKAGE_TOUR_OPERATORS","PAINTBALL","PAINTS_VARNISHES_AND_SUPPLIES","PARKING_LOTS_AND_GARAGES","PARTS_AND_ACCESSORIES","PAWN_SHOPS","PAYCHECK_LENDER_OR_CASH_ADVANCE","PERIPHERALS","PERSONALIZED_GIFTS","PET_SHOPS_PET_FOOD_AND_SUPPLIES","PETROLEUM_AND_PETROLEUM_PRODUCTS","PETS_AND_ANIMALS","PHOTOFINISHING_LABORATORIES_PHOTO_DEVELOPING","PHOTOGRAPHIC_STUDIOS_PORTRAITS","PHOTOGRAPHY","PHYSICAL_GOOD","PICTURE_VIDEO_PRODUCTION","PIECE_GOODS_NOTIONS_AND_OTHER_DRY_GOODS","PLANTS_AND_SEEDS","PLUMBING_AND_HEATING_EQUIPMENTS_AND_SUPPLIES","POLICE_RELATED_ITEMS","POLITICAL_ORGANIZATIONS","POSTAL_SERVICES_GOVERNMENT_ONLY","POSTERS","PREPAID_AND_STORED_VALUE_CARDS","PRESCRIPTION_DRUGS","PROMOTIONAL_ITEMS","PUBLIC_WAREHOUSING_AND_STORAGE","PUBLISHING_AND_PRINTING","PUBLISHING_SERVICES","RADAR_DECTORS","RADIO_TELEVISION_AND_STEREO_REPAIR","REAL_ESTATE","REAL_ESTATE_AGENT","REAL_ESTATE_AGENTS_AND_MANAGERS_RENTALS","RELIGION_AND_SPIRITUALITY_FOR_PROFIT","RELIGIOUS","RELIGIOUS_ORGANIZATIONS","REMITTANCE","RENTAL_PROPERTY_MANAGEMENT","RESIDENTIAL","RETAIL","RETAIL_FINE_JEWELRY_AND_WATCHES","REUPHOLSTERY_AND_FURNITURE_REPAIR","RINGS","ROOFING_SIDING_SHEET_METAL","RUGS_AND_CARPETS","SCHOOLS_AND_COLLEGES","SCIENCE_FICTION","SCRAPBOOKING","SCULPTURES","SECURITIES_BROKERS_AND_DEALERS","SECURITY_AND_SURVEILLANCE","SECURITY_AND_SURVEILLANCE_EQUIPMENT","SECURITY_BROKERS_AND_DEALERS","SEMINARS","SERVICE_STATIONS","SERVICES","SEWING_NEEDLEWORK_FABRIC_AND_PIECE_GOODS_STORES","SHIPPING_AND_PACKING","SHOE_REPAIR_HAT_CLEANING","SHOE_STORES","SHOES","SNOWMOBILE_DEALERS","SOFTWARE","SPECIALTY_AND_MISC","SPECIALTY_CLEANING_POLISHING_AND_SANITATION_PREPARATIONS","SPECIALTY_OR_RARE_PETS","SPORT_GAMES_AND_TOYS","SPORTING_AND_RECREATIONAL_CAMPS","SPORTING_GOODS","SPORTS_AND_OUTDOORS","SPORTS_AND_RECREATION","STAMP_AND_COIN","STATIONARY_PRINTING_AND_WRITING_PAPER","STENOGRAPHIC_AND_SECRETARIAL_SUPPORT_SERVICES","STOCKS_BONDS_SECURITIES_AND_RELATED_CERTIFICATES","STORED_VALUE_CARDS","SUPPLIES","SUPPLIES_AND_TOYS","SURVEILLANCE_EQUIPMENT","SWIMMING_POOLS_AND_SPAS","SWIMMING_POOLS_SALES_SUPPLIES_SERVICES","TAILORS_AND_ALTERATIONS","TAX_PAYMENTS","TAX_PAYMENTS_GOVERNMENT_AGENCIES","TAXICABS_AND_LIMOUSINES","TELECOMMUNICATION_SERVICES","TELEPHONE_CARDS","TELEPHONE_EQUIPMENT","TELEPHONE_SERVICES","THEATER","TIRE_RETREADING_AND_REPAIR","TOLL_OR_BRIDGE_FEES","TOOLS_AND_EQUIPMENT","TOURIST_ATTRACTIONS_AND_EXHIBITS","TOWING_SERVICE","TOYS_AND_GAMES","TRADE_AND_VOCATIONAL_SCHOOLS","TRADEMARK_INFRINGEMENT","TRAILER_PARKS_AND_CAMPGROUNDS","TRAINING_SERVICES","TRANSPORTATION_SERVICES","TRAVEL","TRUCK_AND_UTILITY_TRAILER_RENTALS","TRUCK_STOP","TYPESETTING_PLATE_MAKING_AND_RELATED_SERVICES","USED_MERCHANDISE_AND_SECONDHAND_STORES","USED_PARTS_MOTOR_VEHICLE","UTILITIES","UTILITIES_ELECTRIC_GAS_WATER_SANITARY","VARIETY_STORES","VEHICLE_SALES","VEHICLE_SERVICE_AND_ACCESSORIES","VIDEO_EQUIPMENT","VIDEO_GAME_ARCADES_ESTABLISH","VIDEO_GAMES_AND_SYSTEMS","VIDEO_TAPE_RENTAL_STORES","VINTAGE_AND_COLLECTIBLE_VEHICLES","VINTAGE_AND_COLLECTIBLES","VITAMINS_AND_SUPPLEMENTS","VOCATIONAL_AND_TRADE_SCHOOLS","WATCH_CLOCK_AND_JEWELRY_REPAIR","WEB_HOSTING_AND_DESIGN","WELDING_REPAIR","WHOLESALE_CLUBS","WHOLESALE_FLORIST_SUPPLIERS","WHOLESALE_PRESCRIPTION_DRUGS","WILDLIFE_PRODUCTS","WIRE_TRANSFER","WIRE_TRANSFER_AND_MONEY_ORDER","WOMEN_ACCESSORY_SPECIALITY","WOMEN_CLOTHING"]},"createdAt":{"type":"string","description":"Product creation date (ISO-8601)","format":"date"},"updatedAt":{"type":"string","description":"Product last update date (ISO-8601)","format":"date"},"imageUrl":{"maxLength":2000,"minLength":1,"type":"string","description":"The home page URL for the product"},"homeUrl":{"maxLength":2000,"minLength":1,"type":"string","description":"The image URL for the product"}}}}}}
```

## The payeeInfo object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"payeeInfo":{"required":["email"],"type":"object","properties":{"email":{"type":"string","description":"The email address that is associated with the payee's PayPal account."}}}}}}
```

## The merchant object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"merchant":{"type":"object","properties":{"payeeInfo":{"$ref":"#/components/schemas/payeeInfo"}}},"payeeInfo":{"required":["email"],"type":"object","properties":{"email":{"type":"string","description":"The email address that is associated with the payee's PayPal account."}}}}}}
```

## The billingAddress object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"}}}}
```

## The payerInfo object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"payerInfo":{"required":["email","payerId"],"type":"object","properties":{"email":{"type":"string","description":"The payer's email address."},"suffix":{"type":"string","description":"The payer's name suffix."},"firstName":{"type":"string","description":"The payer's first name."},"lastName":{"type":"string","description":"The payer's last name."},"payerId":{"type":"string","description":"The PayPal-assigned payer ID."},"phone":{"type":"string","description":"The payer's phone number."},"billingAddress":{"$ref":"#/components/schemas/billingAddress"}}},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"}}}}
```

## The payer object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"payer":{"type":"object","properties":{"payerInfo":{"$ref":"#/components/schemas/payerInfo"}}},"payerInfo":{"required":["email","payerId"],"type":"object","properties":{"email":{"type":"string","description":"The payer's email address."},"suffix":{"type":"string","description":"The payer's name suffix."},"firstName":{"type":"string","description":"The payer's first name."},"lastName":{"type":"string","description":"The payer's last name."},"payerId":{"type":"string","description":"The PayPal-assigned payer ID."},"phone":{"type":"string","description":"The payer's phone number."},"billingAddress":{"$ref":"#/components/schemas/billingAddress"}}},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"}}}}
```

## The shippingAddress object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"shippingAddress":{"required":["addressLine1","city","country","countrySubdivision","postalCode"],"type":"object","properties":{"fullName":{"type":"string","description":"Full Name"},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."}}}}}}
```

## The allowedCountries object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"allowedCountries":{"type":"array","description":"An array of legally accepted customer country codes","items":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."}}}}}
```

## The merchantPreferences object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"merchantPreferences":{"type":"object","properties":{"collectShippingAddress":{"type":"string","description":"Indicates whether to skip the collection of the shipping address from the customer during the agreement sign-up phase."},"enableAddressChange":{"type":"string","description":"Indicates whether to show the shipping address but prevent the customer from editing it."},"experienceId":{"type":"string","description":"The ID of the experience profile to apply during the agreement approval UI flow."},"externalSelectedFundingInstrumentType":{"type":"string","description":"The type of financial instrument (FI) that the merchant wants to promote."},"allowedCountries":{"$ref":"#/components/schemas/allowedCountries"}}},"allowedCountries":{"type":"array","description":"An array of legally accepted customer country codes","items":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."}}}}}
```

## The plan object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"plan":{"type":"object","properties":{"merchantPreferences":{"$ref":"#/components/schemas/merchantPreferences"}}},"merchantPreferences":{"type":"object","properties":{"collectShippingAddress":{"type":"string","description":"Indicates whether to skip the collection of the shipping address from the customer during the agreement sign-up phase."},"enableAddressChange":{"type":"string","description":"Indicates whether to show the shipping address but prevent the customer from editing it."},"experienceId":{"type":"string","description":"The ID of the experience profile to apply during the agreement approval UI flow."},"externalSelectedFundingInstrumentType":{"type":"string","description":"The type of financial instrument (FI) that the merchant wants to promote."},"allowedCountries":{"$ref":"#/components/schemas/allowedCountries"}}},"allowedCountries":{"type":"array","description":"An array of legally accepted customer country codes","items":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."}}}}}
```

## The Model8 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model8":{"required":["createTime","id","state"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the agreement."},"state":{"type":"string","description":"The state of the agreement."},"description":{"type":"string","description":"The description of the agreement."},"merchant":{"$ref":"#/components/schemas/merchant"},"payer":{"$ref":"#/components/schemas/payer"},"shippingAddress":{"$ref":"#/components/schemas/shippingAddress"},"plan":{"$ref":"#/components/schemas/plan"},"createTime":{"type":"string","description":"The date and time when the agreement was created."},"updateTime":{"type":"string","description":"The date and time when the agreement was updated."}}},"merchant":{"type":"object","properties":{"payeeInfo":{"$ref":"#/components/schemas/payeeInfo"}}},"payeeInfo":{"required":["email"],"type":"object","properties":{"email":{"type":"string","description":"The email address that is associated with the payee's PayPal account."}}},"payer":{"type":"object","properties":{"payerInfo":{"$ref":"#/components/schemas/payerInfo"}}},"payerInfo":{"required":["email","payerId"],"type":"object","properties":{"email":{"type":"string","description":"The payer's email address."},"suffix":{"type":"string","description":"The payer's name suffix."},"firstName":{"type":"string","description":"The payer's first name."},"lastName":{"type":"string","description":"The payer's last name."},"payerId":{"type":"string","description":"The PayPal-assigned payer ID."},"phone":{"type":"string","description":"The payer's phone number."},"billingAddress":{"$ref":"#/components/schemas/billingAddress"}}},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"},"shippingAddress":{"required":["addressLine1","city","country","countrySubdivision","postalCode"],"type":"object","properties":{"fullName":{"type":"string","description":"Full Name"},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."}}},"plan":{"type":"object","properties":{"merchantPreferences":{"$ref":"#/components/schemas/merchantPreferences"}}},"merchantPreferences":{"type":"object","properties":{"collectShippingAddress":{"type":"string","description":"Indicates whether to skip the collection of the shipping address from the customer during the agreement sign-up phase."},"enableAddressChange":{"type":"string","description":"Indicates whether to show the shipping address but prevent the customer from editing it."},"experienceId":{"type":"string","description":"The ID of the experience profile to apply during the agreement approval UI flow."},"externalSelectedFundingInstrumentType":{"type":"string","description":"The type of financial instrument (FI) that the merchant wants to promote."},"allowedCountries":{"$ref":"#/components/schemas/allowedCountries"}}},"allowedCountries":{"type":"array","description":"An array of legally accepted customer country codes","items":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."}}}}}
```

## The Model9 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model9":{"required":["billingCycles","createTime","name","productId"],"type":"object","properties":{"id":{"maxLength":50,"minLength":6,"type":"string","description":"Filters the response by a Product ID."},"productId":{"type":"string","description":"PayPal catalog product id"},"name":{"maxLength":127,"type":"string","description":"The plan name"},"billingCycles":{"$ref":"#/components/schemas/billingCycles"},"paymentPreferences":{"$ref":"#/components/schemas/paymentPreferences"},"status":{"type":"string","description":"The initial state of the plan","enum":["ACTIVE","INACTIVE","CREATED"]},"description":{"maxLength":127,"type":"string","description":"The detailed description of the plan."},"taxes":{"$ref":"#/components/schemas/taxes"},"quantitySupported":{"type":"boolean","description":"Indicates whether you can subscribe to this plan by providing a quantity for the goods or service."},"createTime":{"type":"string","description":"The date and time when the billing plan was created.","format":"date"},"updateTime":{"type":"string","description":"The date and time when the billing plan was updated.","format":"date"}}},"billingCycles":{"minItems":1,"type":"array","description":"An array of billing cycles for trial billing and regular billing","items":{"$ref":"#/components/schemas/Model2"}},"Model2":{"required":["frequency","sequence","tenureType"],"type":"object","properties":{"pricingScheme":{"$ref":"#/components/schemas/pricingScheme"},"frequency":{"$ref":"#/components/schemas/frequency"},"tenureType":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["REGULAR","TRIAL"]},"sequence":{"type":"number","description":"The order in which this cycle is to run among other billing cycles."},"totalCycles":{"type":"number","description":"The number of times this billing cycle gets executed."}}},"pricingScheme":{"type":"object","properties":{"version":{"maximum":999,"type":"number","description":"The version of the pricing scheme."},"fixedPrice":{"$ref":"#/components/schemas/fixedPrice"},"pricingModel":{"type":"string","description":"The pricing model for tiered plan","enum":["VOLUME","TIERED"]},"tiers":{"$ref":"#/components/schemas/tiers"}},"description":"The active pricing scheme for this billing cycle."},"fixedPrice":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The fixed amount to charge for the subscription"},"tiers":{"type":"array","description":"An array of pricing tiers which are used for billing volume/tiered plans.","items":{"$ref":"#/components/schemas/Model1"}},"Model1":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"string","description":"The starting quantity for the tier."},"endingQuantity":{"type":"string","description":"The ending quantity for the tier. Optional for the last tier."},"amount":{"$ref":"#/components/schemas/amount"}}},"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}},"frequency":{"required":["intervalUnit"],"type":"object","properties":{"intervalUnit":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["DAY","WEEK","MONTH","YEAR"]},"intervalCount":{"type":"number","description":"The number of intervals after which a subscriber is billed."}}},"paymentPreferences":{"type":"object","properties":{"autoBillOutstanding":{"type":"boolean","description":"Indicates whether to automatically bill the outstanding amount in the next billing cycle."},"setupFee":{"$ref":"#/components/schemas/setupFee"},"setupFeeFailureAction":{"type":"string","description":"The action to take on the subscription if the initial payment for the setup fails.","enum":["CONTINUE","CANCEL"]},"paymentFailureThreshold":{"type":"number","description":"The maximum number of payment failures before a subscription is suspended."}},"description":"The payment preferences for a subscription."},"setupFee":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The initial set-up fee for the service."},"taxes":{"required":["percentage"],"type":"object","properties":{"percentage":{"type":"string","description":"The tax percentage on the billing amount."},"inclusive":{"type":"boolean","description":"Indicates whether the tax was already included in the billing amount."}},"description":"The tax details."}}}}
```

## The Model10 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model10":{"required":["createdAt","name","type","updatedAt"],"type":"object","properties":{"id":{"maxLength":50,"minLength":6,"type":"string","description":"The ID of the product. You can specify the SKU for the product. If you omit the ID, the system generates it. System-generated IDs have the PROD- prefix"},"name":{"maxLength":127,"minLength":1,"type":"string","description":"The product name"},"description":{"maxLength":256,"minLength":1,"type":"string","description":"The product description"},"type":{"type":"string","description":"The product type. Indicates whether the product is physical or tangible goods, or a service","enum":["PHYSICAL","DIGITAL","SERVICE"]},"category":{"type":"string","description":"The product category","enum":["AC_REFRIGERATION_REPAIR","ACADEMIC_SOFTWARE","ACCESSORIES","ACCOUNTING","ADULT","ADVERTISING","AFFILIATED_AUTO_RENTAL","AGENCIES","AGGREGATORS","AGRICULTURAL_COOPERATIVE_FOR_MAIL_ORDER","AIR_CARRIERS_AIRLINES","AIRLINES","AIRPORTS_FLYING_FIELDS","ALCOHOLIC_BEVERAGES","AMUSEMENT_PARKS_CARNIVALS","ANIMATION","ANTIQUES","APPLIANCES","AQUARIAMS_SEAQUARIUMS_DOLPHINARIUMS","ARCHITECTURAL_ENGINEERING_AND_SURVEYING_SERVICES","ART_AND_CRAFT_SUPPLIES","ART_DEALERS_AND_GALLERIES","ARTIFACTS_GRAVE_RELATED_AND_NATIVE_AMERICAN_CRAFTS","ARTS_AND_CRAFTS","ARTS_CRAFTS_AND_COLLECTIBLES","AUDIO_BOOKS","AUTO_ASSOCIATIONS_CLUBS","AUTO_DEALER_USED_ONLY","AUTO_RENTALS","AUTO_SERVICE","AUTOMATED_FUEL_DISPENSERS","AUTOMOBILE_ASSOCIATIONS","AUTOMOTIVE","AUTOMOTIVE_REPAIR_SHOPS_NON_DEALER","AUTOMOTIVE_TOP_AND_BODY_SHOPS","AVIATION","BABIES_CLOTHING_AND_SUPPLIES","BABY","BANDS_ORCHESTRAS_ENTERTAINERS","BARBIES","BATH_AND_BODY","BATTERIES","BEAN_BABIES","BEAUTY","BEAUTY_AND_FRAGRANCES","BED_AND_BATH","BICYCLE_SHOPS_SALES_AND_SERVICE","BICYCLES_AND_ACCESSORIES","BILLIARD_POOL_ESTABLISHMENTS","BOAT_DEALERS","BOAT_RENTALS_AND_LEASING","BOATING_SAILING_AND_ACCESSORIES","BOOKS","BOOKS_AND_MAGAZINES","BOOKS_MANUSCRIPTS","BOOKS_PERIODICALS_AND_NEWSPAPERS","BOWLING_ALLEYS","BULLETIN_BOARD","BUS_LINE","BUS_LINES_CHARTERS_TOUR_BUSES","BUSINESS","BUSINESS_AND_SECRETARIAL_SCHOOLS","BUYING_AND_SHOPPING_SERVICES_AND_CLUBS","CABLE_SATELLITE_AND_OTHER_PAY_TELEVISION_AND_RADIO_SERVICES","CABLE_SATELLITE_AND_OTHER_PAY_TV_AND_RADIO","CAMERA_AND_PHOTOGRAPHIC_SUPPLIES","CAMERAS","CAMERAS_AND_PHOTOGRAPHY","CAMPER_RECREATIONAL_AND_UTILITY_TRAILER_DEALERS","CAMPING_AND_OUTDOORS","CAMPING_AND_SURVIVAL","CAR_AND_TRUCK_DEALERS","CAR_AND_TRUCK_DEALERS_USED_ONLY","CAR_AUDIO_AND_ELECTRONICS","CAR_RENTAL_AGENCY","CATALOG_MERCHANT","CATALOG_RETAIL_MERCHANT","CATERING_SERVICES","CHARITY","CHECK_CASHIER","CHILD_CARE_SERVICES","CHILDREN_BOOKS","CHIROPODISTS_PODIATRISTS","CHIROPRACTORS","CIGAR_STORES_AND_STANDS","CIVIC_SOCIAL_FRATERNAL_ASSOCIATIONS","CIVIL_SOCIAL_FRAT_ASSOCIATIONS","CLOTHING","CLOTHING_ACCESSORIES_AND_SHOES","CLOTHING_RENTAL","COFFEE_AND_TEA","COIN_OPERATED_BANKS_AND_CASINOS","COLLECTIBLES","COLLECTION_AGENCY","COLLEGES_AND_UNIVERSITIES","COMMERCIAL_EQUIPMENT","COMMERCIAL_FOOTWEAR","COMMERCIAL_PHOTOGRAPHY","COMMERCIAL_PHOTOGRAPHY_ART_AND_GRAPHICS","COMMERCIAL_SPORTS_PROFESSIONA","COMMODITIES_AND_FUTURES_EXCHANGE","COMPUTER_AND_DATA_PROCESSING_SERVICES","COMPUTER_HARDWARE_AND_SOFTWARE","COMPUTER_MAINTENANCE_REPAIR_AND_SERVICES_NOT_ELSEWHERE_CLAS","CONSTRUCTION","CONSTRUCTION_MATERIALS_NOT_ELSEWHERE_CLASSIFIED","CONSULTING_SERVICES","CONSUMER_CREDIT_REPORTING_AGENCIES","CONVALESCENT_HOMES","COSMETIC_STORES","COUNSELING_SERVICES_DEBT_MARRIAGE_PERSONAL","COUNTERFEIT_CURRENCY_AND_STAMPS","COUNTERFEIT_ITEMS","COUNTRY_CLUBS","COURIER_SERVICES","COURIER_SERVICES_AIR_AND_GROUND_AND_FREIGHT_FORWARDERS","COURT_COSTS_ALIMNY_CHILD_SUPT","COURT_COSTS_INCLUDING_ALIMONY_AND_CHILD_SUPPORT_COURTS_OF_LAW","CREDIT_CARDS","CREDIT_UNION","CULTURE_AND_RELIGION","DAIRY_PRODUCTS_STORES","DANCE_HALLS_STUDIOS_AND_SCHOOLS","DECORATIVE","DENTAL","DENTISTS_AND_ORTHODONTISTS","DEPARTMENT_STORES","DESKTOP_PCS","DEVICES","DIECAST_TOYS_VEHICLES","DIGITAL_GAMES","DIGITAL_MEDIA_BOOKS_MOVIES_MUSIC","DIRECT_MARKETING","DIRECT_MARKETING_CATALOG_MERCHANT","DIRECT_MARKETING_INBOUND_TELE","DIRECT_MARKETING_OUTBOUND_TELE","DIRECT_MARKETING_SUBSCRIPTION","DISCOUNT_STORES","DOOR_TO_DOOR_SALES","DRAPERY_WINDOW_COVERING_AND_UPHOLSTERY","DRINKING_PLACES","DRUGSTORE","DURABLE_GOODS","ECOMMERCE_DEVELOPMENT","ECOMMERCE_SERVICES","EDUCATIONAL_AND_TEXTBOOKS","ELECTRIC_RAZOR_STORES","ELECTRICAL_AND_SMALL_APPLIANCE_REPAIR","ELECTRICAL_CONTRACTORS","ELECTRICAL_PARTS_AND_EQUIPMENT","ELECTRONIC_CASH","ELEMENTARY_AND_SECONDARY_SCHOOLS","EMPLOYMENT","ENTERTAINERS","ENTERTAINMENT_AND_MEDIA","EQUIP_TOOL_FURNITURE_AND_APPLIANCE_RENTAL_AND_LEASING","ESCROW","EVENT_AND_WEDDING_PLANNING","EXERCISE_AND_FITNESS","EXERCISE_EQUIPMENT","EXTERMINATING_AND_DISINFECTING_SERVICES","FABRICS_AND_SEWING","FAMILY_CLOTHING_STORES","FASHION_JEWELRY","FAST_FOOD_RESTAURANTS","FICTION_AND_NONFICTION","FINANCE_COMPANY","FINANCIAL_AND_INVESTMENT_ADVICE","FINANCIAL_INSTITUTIONS_MERCHANDISE_AND_SERVICES","FIREARM_ACCESSORIES","FIREARMS_WEAPONS_AND_KNIVES","FIREPLACE_AND_FIREPLACE_SCREENS","FIREWORKS","FISHING","FLORISTS","FLOWERS","FOOD_DRINK_AND_NUTRITION","FOOD_PRODUCTS","FOOD_RETAIL_AND_SERVICE","FRAGRANCES_AND_PERFUMES","FREEZER_AND_LOCKER_MEAT_PROVISIONERS","FUEL_DEALERS_FUEL_OIL_WOOD_AND_COAL","FUEL_DEALERS_NON_AUTOMOTIVE","FUNERAL_SERVICES_AND_CREMATORIES","FURNISHING_AND_DECORATING","FURNITURE","FURRIERS_AND_FUR_SHOPS","GADGETS_AND_OTHER_ELECTRONICS","GAMBLING","GAME_SOFTWARE","GAMES","GARDEN_SUPPLIES","GENERAL","GENERAL_CONTRACTORS","GENERAL_GOVERNMENT","GENERAL_SOFTWARE","GENERAL_TELECOM","GIFTS_AND_FLOWERS","GLASS_PAINT_AND_WALLPAPER_STORES","GLASSWARE_CRYSTAL_STORES","GOVERNMENT","GOVERNMENT_IDS_AND_LICENSES","GOVERNMENT_LICENSED_ON_LINE_CASINOS_ON_LINE_GAMBLING","GOVERNMENT_OWNED_LOTTERIES","GOVERNMENT_SERVICES","GRAPHIC_AND_COMMERCIAL_DESIGN","GREETING_CARDS","GROCERY_STORES_AND_SUPERMARKETS","HARDWARE_AND_TOOLS","HARDWARE_EQUIPMENT_AND_SUPPLIES","HAZARDOUS_RESTRICTED_AND_PERISHABLE_ITEMS","HEALTH_AND_BEAUTY_SPAS","HEALTH_AND_NUTRITION","HEALTH_AND_PERSONAL_CARE","HEARING_AIDS_SALES_AND_SUPPLIES","HEATING_PLUMBING_AC","HIGH_RISK_MERCHANT","HIRING_SERVICES","HOBBIES_TOYS_AND_GAMES","HOME_AND_GARDEN","HOME_AUDIO","HOME_DECOR","HOME_ELECTRONICS","HOSPITALS","HOTELS_MOTELS_INNS_RESORTS","HOUSEWARES","HUMAN_PARTS_AND_REMAINS","HUMOROUS_GIFTS_AND_NOVELTIES","HUNTING","IDS_LICENSES_AND_PASSPORTS","ILLEGAL_DRUGS_AND_PARAPHERNALIA","INDUSTRIAL","INDUSTRIAL_AND_MANUFACTURING_SUPPLIES","INSURANCE_AUTO_AND_HOME","INSURANCE_DIRECT","INSURANCE_LIFE_AND_ANNUITY","INSURANCE_SALES_UNDERWRITING","INSURANCE_UNDERWRITING_PREMIUMS","INTERNET_AND_NETWORK_SERVICES","INTRA_COMPANY_PURCHASES","LABORATORIES_DENTAL_MEDICAL","LANDSCAPING","LANDSCAPING_AND_HORTICULTURAL_SERVICES","LAUNDRY_CLEANING_SERVICES","LEGAL","LEGAL_SERVICES_AND_ATTORNEYS","LOCAL_DELIVERY_SERVICE","LOCKSMITH","LODGING_AND_ACCOMMODATIONS","LOTTERY_AND_CONTESTS","LUGGAGE_AND_LEATHER_GOODS","LUMBER_AND_BUILDING_MATERIALS","MAGAZINES","MAINTENANCE_AND_REPAIR_SERVICES","MAKEUP_AND_COSMETICS","MANUAL_CASH_DISBURSEMENTS","MASSAGE_PARLORS","MEDICAL","MEDICAL_AND_PHARMACEUTICAL","MEDICAL_CARE","MEDICAL_EQUIPMENT_AND_SUPPLIES","MEDICAL_SERVICES","MEETING_PLANNERS","MEMBERSHIP_CLUBS_AND_ORGANIZATIONS","MEMBERSHIP_COUNTRY_CLUBS_GOLF","MEMORABILIA","MEN_AND_BOY_CLOTHING_AND_ACCESSORY_STORES","MEN_CLOTHING","MERCHANDISE","METAPHYSICAL","MILITARIA","MILITARY_AND_CIVIL_SERVICE_UNIFORMS","MISC","MISCELLANEOUS_GENERAL_SERVICES","MISCELLANEOUS_REPAIR_SHOPS_AND_RELATED_SERVICES","MODEL_KITS","MONEY_TRANSFER_MEMBER_FINANCIAL_INSTITUTION","MONEY_TRANSFER_MERCHANT","MOTION_PICTURE_THEATERS","MOTOR_FREIGHT_CARRIERS_AND_TRUCKING","MOTOR_HOME_AND_RECREATIONAL_VEHICLE_RENTAL","MOTOR_HOMES_DEALERS","MOTOR_VEHICLE_SUPPLIES_AND_NEW_PARTS","MOTORCYCLE_DEALERS","MOTORCYCLES","MOVIE","MOVIE_TICKETS","MOVING_AND_STORAGE","MULTI_LEVEL_MARKETING","MUSIC_CDS_CASSETTES_AND_ALBUMS","MUSIC_STORE_INSTRUMENTS_AND_SHEET_MUSIC","NETWORKING","NEW_AGE","NEW_PARTS_AND_SUPPLIES_MOTOR_VEHICLE","NEWS_DEALERS_AND_NEWSTANDS","NON_DURABLE_GOODS","NON_FICTION","NON_PROFIT_POLITICAL_AND_RELIGION","NONPROFIT","NOVELTIES","OEM_SOFTWARE","OFFICE_SUPPLIES_AND_EQUIPMENT","ONLINE_DATING","ONLINE_GAMING","ONLINE_GAMING_CURRENCY","ONLINE_SERVICES","OOUTBOUND_TELEMARKETING_MERCH","OPHTHALMOLOGISTS_OPTOMETRIST","OPTICIANS_AND_DISPENSING","ORTHOPEDIC_GOODS_PROSTHETICS","OSTEOPATHS","OTHER","PACKAGE_TOUR_OPERATORS","PAINTBALL","PAINTS_VARNISHES_AND_SUPPLIES","PARKING_LOTS_AND_GARAGES","PARTS_AND_ACCESSORIES","PAWN_SHOPS","PAYCHECK_LENDER_OR_CASH_ADVANCE","PERIPHERALS","PERSONALIZED_GIFTS","PET_SHOPS_PET_FOOD_AND_SUPPLIES","PETROLEUM_AND_PETROLEUM_PRODUCTS","PETS_AND_ANIMALS","PHOTOFINISHING_LABORATORIES_PHOTO_DEVELOPING","PHOTOGRAPHIC_STUDIOS_PORTRAITS","PHOTOGRAPHY","PHYSICAL_GOOD","PICTURE_VIDEO_PRODUCTION","PIECE_GOODS_NOTIONS_AND_OTHER_DRY_GOODS","PLANTS_AND_SEEDS","PLUMBING_AND_HEATING_EQUIPMENTS_AND_SUPPLIES","POLICE_RELATED_ITEMS","POLITICAL_ORGANIZATIONS","POSTAL_SERVICES_GOVERNMENT_ONLY","POSTERS","PREPAID_AND_STORED_VALUE_CARDS","PRESCRIPTION_DRUGS","PROMOTIONAL_ITEMS","PUBLIC_WAREHOUSING_AND_STORAGE","PUBLISHING_AND_PRINTING","PUBLISHING_SERVICES","RADAR_DECTORS","RADIO_TELEVISION_AND_STEREO_REPAIR","REAL_ESTATE","REAL_ESTATE_AGENT","REAL_ESTATE_AGENTS_AND_MANAGERS_RENTALS","RELIGION_AND_SPIRITUALITY_FOR_PROFIT","RELIGIOUS","RELIGIOUS_ORGANIZATIONS","REMITTANCE","RENTAL_PROPERTY_MANAGEMENT","RESIDENTIAL","RETAIL","RETAIL_FINE_JEWELRY_AND_WATCHES","REUPHOLSTERY_AND_FURNITURE_REPAIR","RINGS","ROOFING_SIDING_SHEET_METAL","RUGS_AND_CARPETS","SCHOOLS_AND_COLLEGES","SCIENCE_FICTION","SCRAPBOOKING","SCULPTURES","SECURITIES_BROKERS_AND_DEALERS","SECURITY_AND_SURVEILLANCE","SECURITY_AND_SURVEILLANCE_EQUIPMENT","SECURITY_BROKERS_AND_DEALERS","SEMINARS","SERVICE_STATIONS","SERVICES","SEWING_NEEDLEWORK_FABRIC_AND_PIECE_GOODS_STORES","SHIPPING_AND_PACKING","SHOE_REPAIR_HAT_CLEANING","SHOE_STORES","SHOES","SNOWMOBILE_DEALERS","SOFTWARE","SPECIALTY_AND_MISC","SPECIALTY_CLEANING_POLISHING_AND_SANITATION_PREPARATIONS","SPECIALTY_OR_RARE_PETS","SPORT_GAMES_AND_TOYS","SPORTING_AND_RECREATIONAL_CAMPS","SPORTING_GOODS","SPORTS_AND_OUTDOORS","SPORTS_AND_RECREATION","STAMP_AND_COIN","STATIONARY_PRINTING_AND_WRITING_PAPER","STENOGRAPHIC_AND_SECRETARIAL_SUPPORT_SERVICES","STOCKS_BONDS_SECURITIES_AND_RELATED_CERTIFICATES","STORED_VALUE_CARDS","SUPPLIES","SUPPLIES_AND_TOYS","SURVEILLANCE_EQUIPMENT","SWIMMING_POOLS_AND_SPAS","SWIMMING_POOLS_SALES_SUPPLIES_SERVICES","TAILORS_AND_ALTERATIONS","TAX_PAYMENTS","TAX_PAYMENTS_GOVERNMENT_AGENCIES","TAXICABS_AND_LIMOUSINES","TELECOMMUNICATION_SERVICES","TELEPHONE_CARDS","TELEPHONE_EQUIPMENT","TELEPHONE_SERVICES","THEATER","TIRE_RETREADING_AND_REPAIR","TOLL_OR_BRIDGE_FEES","TOOLS_AND_EQUIPMENT","TOURIST_ATTRACTIONS_AND_EXHIBITS","TOWING_SERVICE","TOYS_AND_GAMES","TRADE_AND_VOCATIONAL_SCHOOLS","TRADEMARK_INFRINGEMENT","TRAILER_PARKS_AND_CAMPGROUNDS","TRAINING_SERVICES","TRANSPORTATION_SERVICES","TRAVEL","TRUCK_AND_UTILITY_TRAILER_RENTALS","TRUCK_STOP","TYPESETTING_PLATE_MAKING_AND_RELATED_SERVICES","USED_MERCHANDISE_AND_SECONDHAND_STORES","USED_PARTS_MOTOR_VEHICLE","UTILITIES","UTILITIES_ELECTRIC_GAS_WATER_SANITARY","VARIETY_STORES","VEHICLE_SALES","VEHICLE_SERVICE_AND_ACCESSORIES","VIDEO_EQUIPMENT","VIDEO_GAME_ARCADES_ESTABLISH","VIDEO_GAMES_AND_SYSTEMS","VIDEO_TAPE_RENTAL_STORES","VINTAGE_AND_COLLECTIBLE_VEHICLES","VINTAGE_AND_COLLECTIBLES","VITAMINS_AND_SUPPLEMENTS","VOCATIONAL_AND_TRADE_SCHOOLS","WATCH_CLOCK_AND_JEWELRY_REPAIR","WEB_HOSTING_AND_DESIGN","WELDING_REPAIR","WHOLESALE_CLUBS","WHOLESALE_FLORIST_SUPPLIERS","WHOLESALE_PRESCRIPTION_DRUGS","WILDLIFE_PRODUCTS","WIRE_TRANSFER","WIRE_TRANSFER_AND_MONEY_ORDER","WOMEN_ACCESSORY_SPECIALITY","WOMEN_CLOTHING"]},"imageUrl":{"maxLength":2000,"minLength":1,"type":"string","description":"The home page URL for the product"},"homeUrl":{"maxLength":2000,"minLength":1,"type":"string","description":"The image URL for the product"},"createdAt":{"type":"string","description":"Product creation date (ISO-8601)","format":"date"},"updatedAt":{"type":"string","description":"Product last update date (ISO-8601)","format":"date"}}}}}}
```

## The shippingAmount object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"shippingAmount":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The currency and amount for a financial transaction, such as a balance or payment due"}}}}
```

## The name object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"name":{"type":"object","properties":{"givenName":{"maxLength":140,"type":"string"},"surname":{"maxLength":140,"type":"string"}},"description":"The name of the payer"}}}}
```

## The phoneNumber object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"phoneNumber":{"required":["nationalNumber"],"type":"object","properties":{"nationalNumber":{"maxLength":14,"minLength":1,"pattern":"^[0-9]{1,14}?$","type":"string"}},"description":"The phone number, in its canonical international E.164 numbering plan format"}}}}
```

## The phone object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"phone":{"required":["phoneNumber"],"type":"object","properties":{"phoneType":{"type":"string","description":"The phone type","enum":["FAX","HOME","MOBILE","OTHER","PAGER"]},"phoneNumber":{"$ref":"#/components/schemas/phoneNumber"}},"description":"The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account"},"phoneNumber":{"required":["nationalNumber"],"type":"object","properties":{"nationalNumber":{"maxLength":14,"minLength":1,"pattern":"^[0-9]{1,14}?$","type":"string"}},"description":"The phone number, in its canonical international E.164 numbering plan format"}}}}
```

## The Model11 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model11":{"type":"object","properties":{"fullName":{"maxLength":300,"type":"string"}},"description":"The name of the person to whom to ship the items"}}}}
```

## The Model12 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model12":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Model11"},"address":{"$ref":"#/components/schemas/billingAddress"}},"description":"The shipping details"},"Model11":{"type":"object","properties":{"fullName":{"maxLength":300,"type":"string"}},"description":"The name of the person to whom to ship the items"},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"}}}}
```

## The subscriber object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"subscriber":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/name"},"payerId":{"pattern":"^[2-9A-HJ-NP-Z]{13}$","type":"string","description":"The PayPal-assigned ID for the payer"},"emailAddress":{"maxLength":255,"type":"string","description":"Customer email address"},"phone":{"$ref":"#/components/schemas/phone"},"shippingAddress":{"$ref":"#/components/schemas/Model12"}},"description":"The subscriber request information"},"name":{"type":"object","properties":{"givenName":{"maxLength":140,"type":"string"},"surname":{"maxLength":140,"type":"string"}},"description":"The name of the payer"},"phone":{"required":["phoneNumber"],"type":"object","properties":{"phoneType":{"type":"string","description":"The phone type","enum":["FAX","HOME","MOBILE","OTHER","PAGER"]},"phoneNumber":{"$ref":"#/components/schemas/phoneNumber"}},"description":"The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account"},"phoneNumber":{"required":["nationalNumber"],"type":"object","properties":{"nationalNumber":{"maxLength":14,"minLength":1,"pattern":"^[0-9]{1,14}?$","type":"string"}},"description":"The phone number, in its canonical international E.164 numbering plan format"},"Model12":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Model11"},"address":{"$ref":"#/components/schemas/billingAddress"}},"description":"The shipping details"},"Model11":{"type":"object","properties":{"fullName":{"maxLength":300,"type":"string"}},"description":"The name of the person to whom to ship the items"},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"}}}}
```

## The outstandingBalance object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"outstandingBalance":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The total pending bill amount, to be paid by the subscriber"}}}}
```

## The Model13 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model13":{"required":["cyclesCompleted","sequence","tenureType"],"type":"object","properties":{"tenureType":{"type":"string","description":"The type of the billing cycle","enum":["REGULAR","TRIAL"]},"sequence":{"type":"integer","description":"The order in which to run this cycle among other billing cycles"},"cyclesCompleted":{"type":"integer","description":"The number of billing cycles that have completed"},"cyclesRemaining":{"type":"integer","description":"For a finite billing cycle, cyclesRemaining is the number of remaining cycles. For an infinite billing cycle, cyclesRemaining is set as 0."},"currentPricingSchemeVersion":{"type":"integer","description":"The active pricing scheme version for the billing cycle"},"totalCycles":{"type":"integer","description":"The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for totalCycles). Regular billing cycles can be executed infinite times (value of 0 for totalCycles) or a finite number of times (value between 1 and 999 for totalCycles)."}}}}}}
```

## The cycleExecutions object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"cycleExecutions":{"type":"array","items":{"$ref":"#/components/schemas/Model13"}},"Model13":{"required":["cyclesCompleted","sequence","tenureType"],"type":"object","properties":{"tenureType":{"type":"string","description":"The type of the billing cycle","enum":["REGULAR","TRIAL"]},"sequence":{"type":"integer","description":"The order in which to run this cycle among other billing cycles"},"cyclesCompleted":{"type":"integer","description":"The number of billing cycles that have completed"},"cyclesRemaining":{"type":"integer","description":"For a finite billing cycle, cyclesRemaining is the number of remaining cycles. For an infinite billing cycle, cyclesRemaining is set as 0."},"currentPricingSchemeVersion":{"type":"integer","description":"The active pricing scheme version for the billing cycle"},"totalCycles":{"type":"integer","description":"The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for totalCycles). Regular billing cycles can be executed infinite times (value of 0 for totalCycles) or a finite number of times (value between 1 and 999 for totalCycles)."}}}}}}
```

## The Model14 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model14":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The last payment amount"}}}}
```

## The lastPayment object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"lastPayment":{"type":"object","properties":{"status":{"type":"string","description":"The status of the captured payment"},"amount":{"$ref":"#/components/schemas/Model14"},"time":{"type":"string","description":"The date and time when the last payment was made","format":"date"}},"description":"The details for the last payment of the subscription"},"Model14":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The last payment amount"}}}}
```

## The Model15 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model15":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The failed payment amount"}}}}
```

## The lastFailedPayment object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"lastFailedPayment":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Model15"},"time":{"type":"string","description":"The date and time when the failed payment was made","format":"date"},"reasonCode":{"type":"string","description":"The reason code for the payment failure","enum":["CURRENCY_MISMATCH","INTERNAL_SERVER_ERROR","PAYEE_ACCOUNT_RESTRICTED","PAYER_ACCOUNT_RESTRICTED","PAYER_CANNOT_PAY","PAYMENT_DENIED","TRANSACTION_RECEIVING_LIMIT_EXCEEDED","SENDING_LIMIT_EXCEEDED"]},"nextPaymentRetryTime":{"type":"string","description":"The time when the retry attempt for the failed payment occurs","format":"date"}},"description":"The details for the last failed payment of the subscription"},"Model15":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The failed payment amount"}}}}
```

## The billingInfo object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"billingInfo":{"required":["failedPaymentsCount","outstandingBalance"],"type":"object","properties":{"outstandingBalance":{"$ref":"#/components/schemas/outstandingBalance"},"cycleExecutions":{"$ref":"#/components/schemas/cycleExecutions"},"lastPayment":{"$ref":"#/components/schemas/lastPayment"},"nextBillingTime":{"type":"string"},"finalPaymentTime":{"type":"string"},"failedPaymentsCount":{"type":"number"},"lastFailedPayment":{"$ref":"#/components/schemas/lastFailedPayment"}}},"outstandingBalance":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The total pending bill amount, to be paid by the subscriber"},"cycleExecutions":{"type":"array","items":{"$ref":"#/components/schemas/Model13"}},"Model13":{"required":["cyclesCompleted","sequence","tenureType"],"type":"object","properties":{"tenureType":{"type":"string","description":"The type of the billing cycle","enum":["REGULAR","TRIAL"]},"sequence":{"type":"integer","description":"The order in which to run this cycle among other billing cycles"},"cyclesCompleted":{"type":"integer","description":"The number of billing cycles that have completed"},"cyclesRemaining":{"type":"integer","description":"For a finite billing cycle, cyclesRemaining is the number of remaining cycles. For an infinite billing cycle, cyclesRemaining is set as 0."},"currentPricingSchemeVersion":{"type":"integer","description":"The active pricing scheme version for the billing cycle"},"totalCycles":{"type":"integer","description":"The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for totalCycles). Regular billing cycles can be executed infinite times (value of 0 for totalCycles) or a finite number of times (value between 1 and 999 for totalCycles)."}}},"lastPayment":{"type":"object","properties":{"status":{"type":"string","description":"The status of the captured payment"},"amount":{"$ref":"#/components/schemas/Model14"},"time":{"type":"string","description":"The date and time when the last payment was made","format":"date"}},"description":"The details for the last payment of the subscription"},"Model14":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The last payment amount"},"lastFailedPayment":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Model15"},"time":{"type":"string","description":"The date and time when the failed payment was made","format":"date"},"reasonCode":{"type":"string","description":"The reason code for the payment failure","enum":["CURRENCY_MISMATCH","INTERNAL_SERVER_ERROR","PAYEE_ACCOUNT_RESTRICTED","PAYER_ACCOUNT_RESTRICTED","PAYER_CANNOT_PAY","PAYMENT_DENIED","TRANSACTION_RECEIVING_LIMIT_EXCEEDED","SENDING_LIMIT_EXCEEDED"]},"nextPaymentRetryTime":{"type":"string","description":"The time when the retry attempt for the failed payment occurs","format":"date"}},"description":"The details for the last failed payment of the subscription"},"Model15":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The failed payment amount"}}}}
```

## The Model16 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model16":{"required":["planId"],"type":"object","properties":{"id":{"type":"string","description":"ID of the subscription"},"status":{"type":"string","description":"The status of the subscription","enum":["APPROVAL_PENDING","ACTIVE","APPROVED","CANCELLED","EXPIRED","SUSPENDED"]},"planId":{"maxLength":50,"minLength":3,"type":"string","description":"The ID of the plan"},"planOverridden":{"type":"boolean","description":"Indicates whether the subscription has overridden any plan attributes"},"statusUpdateTime":{"type":"string","description":"The date and time when the subscription status updated last time","format":"date"},"statusChangeNote":{"type":"string","description":"The reason or notes for the status of the subscription"},"startTime":{"type":"string","description":"The date and time when the subscription started","format":"date"},"quantity":{"type":"integer","description":"The quantity of the product in the subscription"},"customId":{"maxLength":127,"minLength":1,"pattern":"^[ -~]+","type":"string","description":"The custom id for the subscription. Can be invoice id"},"shippingAmount":{"$ref":"#/components/schemas/shippingAmount"},"subscriber":{"$ref":"#/components/schemas/subscriber"},"billingInfo":{"$ref":"#/components/schemas/billingInfo"},"createdAt":{"type":"string","description":"The date and time when the subscription created","format":"date"},"updatedAt":{"type":"string","description":"The date and time when the subscription updated last time","format":"date"}}},"shippingAmount":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The currency and amount for a financial transaction, such as a balance or payment due"},"subscriber":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/name"},"payerId":{"pattern":"^[2-9A-HJ-NP-Z]{13}$","type":"string","description":"The PayPal-assigned ID for the payer"},"emailAddress":{"maxLength":255,"type":"string","description":"Customer email address"},"phone":{"$ref":"#/components/schemas/phone"},"shippingAddress":{"$ref":"#/components/schemas/Model12"}},"description":"The subscriber request information"},"name":{"type":"object","properties":{"givenName":{"maxLength":140,"type":"string"},"surname":{"maxLength":140,"type":"string"}},"description":"The name of the payer"},"phone":{"required":["phoneNumber"],"type":"object","properties":{"phoneType":{"type":"string","description":"The phone type","enum":["FAX","HOME","MOBILE","OTHER","PAGER"]},"phoneNumber":{"$ref":"#/components/schemas/phoneNumber"}},"description":"The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account"},"phoneNumber":{"required":["nationalNumber"],"type":"object","properties":{"nationalNumber":{"maxLength":14,"minLength":1,"pattern":"^[0-9]{1,14}?$","type":"string"}},"description":"The phone number, in its canonical international E.164 numbering plan format"},"Model12":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Model11"},"address":{"$ref":"#/components/schemas/billingAddress"}},"description":"The shipping details"},"Model11":{"type":"object","properties":{"fullName":{"maxLength":300,"type":"string"}},"description":"The name of the person to whom to ship the items"},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"},"billingInfo":{"required":["failedPaymentsCount","outstandingBalance"],"type":"object","properties":{"outstandingBalance":{"$ref":"#/components/schemas/outstandingBalance"},"cycleExecutions":{"$ref":"#/components/schemas/cycleExecutions"},"lastPayment":{"$ref":"#/components/schemas/lastPayment"},"nextBillingTime":{"type":"string"},"finalPaymentTime":{"type":"string"},"failedPaymentsCount":{"type":"number"},"lastFailedPayment":{"$ref":"#/components/schemas/lastFailedPayment"}}},"outstandingBalance":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The total pending bill amount, to be paid by the subscriber"},"cycleExecutions":{"type":"array","items":{"$ref":"#/components/schemas/Model13"}},"Model13":{"required":["cyclesCompleted","sequence","tenureType"],"type":"object","properties":{"tenureType":{"type":"string","description":"The type of the billing cycle","enum":["REGULAR","TRIAL"]},"sequence":{"type":"integer","description":"The order in which to run this cycle among other billing cycles"},"cyclesCompleted":{"type":"integer","description":"The number of billing cycles that have completed"},"cyclesRemaining":{"type":"integer","description":"For a finite billing cycle, cyclesRemaining is the number of remaining cycles. For an infinite billing cycle, cyclesRemaining is set as 0."},"currentPricingSchemeVersion":{"type":"integer","description":"The active pricing scheme version for the billing cycle"},"totalCycles":{"type":"integer","description":"The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for totalCycles). Regular billing cycles can be executed infinite times (value of 0 for totalCycles) or a finite number of times (value between 1 and 999 for totalCycles)."}}},"lastPayment":{"type":"object","properties":{"status":{"type":"string","description":"The status of the captured payment"},"amount":{"$ref":"#/components/schemas/Model14"},"time":{"type":"string","description":"The date and time when the last payment was made","format":"date"}},"description":"The details for the last payment of the subscription"},"Model14":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The last payment amount"},"lastFailedPayment":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Model15"},"time":{"type":"string","description":"The date and time when the failed payment was made","format":"date"},"reasonCode":{"type":"string","description":"The reason code for the payment failure","enum":["CURRENCY_MISMATCH","INTERNAL_SERVER_ERROR","PAYEE_ACCOUNT_RESTRICTED","PAYER_ACCOUNT_RESTRICTED","PAYER_CANNOT_PAY","PAYMENT_DENIED","TRANSACTION_RECEIVING_LIMIT_EXCEEDED","SENDING_LIMIT_EXCEEDED"]},"nextPaymentRetryTime":{"type":"string","description":"The time when the retry attempt for the failed payment occurs","format":"date"}},"description":"The details for the last failed payment of the subscription"},"Model15":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The failed payment amount"}}}}
```

## The redirectUrls object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"redirectUrls":{"type":"object","properties":{"returnUrl":{"type":"string","description":"The URL where the customer is redirected after the customer approves the payment"},"cancelUrl":{"type":"string","description":"The URL where the customer is redirected after the customer cancels the payment"}}}}}}
```

## The Model17 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model17":{"required":["tokenId"],"type":"object","properties":{"tokenId":{"type":"string","description":"The state of the agreement."},"status":{"type":"string","description":"The description of the agreement."},"description":{"type":"string","description":"The description of the agreement."},"collectShippingAddress":{"type":"boolean","description":"Indicates whether to skip the collection of the shipping address from the customer during the agreement sign-up phase."},"enableAddressChange":{"type":"boolean","description":"Indicates whether to show the shipping address but prevent the customer from editing it."},"payerInfo":{"$ref":"#/components/schemas/payerInfo"},"redirectUrls":{"$ref":"#/components/schemas/redirectUrls"},"experienceId":{"type":"string","description":"The ID of the experience profile to apply during the agreement approval UI flow."},"externalSelectedFundingInstrumentType":{"type":"string","description":"The type of financial instrument (FI) that the merchant wants to promote.","enum":["CREDIT","PAY_UPON_INVOICE"]}}},"payerInfo":{"required":["email","payerId"],"type":"object","properties":{"email":{"type":"string","description":"The payer's email address."},"suffix":{"type":"string","description":"The payer's name suffix."},"firstName":{"type":"string","description":"The payer's first name."},"lastName":{"type":"string","description":"The payer's last name."},"payerId":{"type":"string","description":"The PayPal-assigned payer ID."},"phone":{"type":"string","description":"The payer's phone number."},"billingAddress":{"$ref":"#/components/schemas/billingAddress"}}},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"},"redirectUrls":{"type":"object","properties":{"returnUrl":{"type":"string","description":"The URL where the customer is redirected after the customer approves the payment"},"cancelUrl":{"type":"string","description":"The URL where the customer is redirected after the customer cancels the payment"}}}}}}
```

## The Model18 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model18":{"required":["name","paymentProviderContract","type"],"type":"object","properties":{"paymentProviderContract":{"type":"string","description":"PayPal Payment Provider Contract UUID"},"id":{"maxLength":50,"minLength":6,"type":"string","description":"The ID of the product. You can specify the SKU for the product. If you omit the ID, the system generates it. System-generated IDs have the PROD- prefix"},"name":{"maxLength":127,"minLength":1,"type":"string","description":"The product name"},"description":{"maxLength":256,"minLength":1,"type":"string","description":"The product description"},"type":{"type":"string","description":"The product type. Indicates whether the product is physical or tangible goods, or a service","enum":["PHYSICAL","DIGITAL","SERVICE"]},"category":{"type":"string","description":"The product category","enum":["AC_REFRIGERATION_REPAIR","ACADEMIC_SOFTWARE","ACCESSORIES","ACCOUNTING","ADULT","ADVERTISING","AFFILIATED_AUTO_RENTAL","AGENCIES","AGGREGATORS","AGRICULTURAL_COOPERATIVE_FOR_MAIL_ORDER","AIR_CARRIERS_AIRLINES","AIRLINES","AIRPORTS_FLYING_FIELDS","ALCOHOLIC_BEVERAGES","AMUSEMENT_PARKS_CARNIVALS","ANIMATION","ANTIQUES","APPLIANCES","AQUARIAMS_SEAQUARIUMS_DOLPHINARIUMS","ARCHITECTURAL_ENGINEERING_AND_SURVEYING_SERVICES","ART_AND_CRAFT_SUPPLIES","ART_DEALERS_AND_GALLERIES","ARTIFACTS_GRAVE_RELATED_AND_NATIVE_AMERICAN_CRAFTS","ARTS_AND_CRAFTS","ARTS_CRAFTS_AND_COLLECTIBLES","AUDIO_BOOKS","AUTO_ASSOCIATIONS_CLUBS","AUTO_DEALER_USED_ONLY","AUTO_RENTALS","AUTO_SERVICE","AUTOMATED_FUEL_DISPENSERS","AUTOMOBILE_ASSOCIATIONS","AUTOMOTIVE","AUTOMOTIVE_REPAIR_SHOPS_NON_DEALER","AUTOMOTIVE_TOP_AND_BODY_SHOPS","AVIATION","BABIES_CLOTHING_AND_SUPPLIES","BABY","BANDS_ORCHESTRAS_ENTERTAINERS","BARBIES","BATH_AND_BODY","BATTERIES","BEAN_BABIES","BEAUTY","BEAUTY_AND_FRAGRANCES","BED_AND_BATH","BICYCLE_SHOPS_SALES_AND_SERVICE","BICYCLES_AND_ACCESSORIES","BILLIARD_POOL_ESTABLISHMENTS","BOAT_DEALERS","BOAT_RENTALS_AND_LEASING","BOATING_SAILING_AND_ACCESSORIES","BOOKS","BOOKS_AND_MAGAZINES","BOOKS_MANUSCRIPTS","BOOKS_PERIODICALS_AND_NEWSPAPERS","BOWLING_ALLEYS","BULLETIN_BOARD","BUS_LINE","BUS_LINES_CHARTERS_TOUR_BUSES","BUSINESS","BUSINESS_AND_SECRETARIAL_SCHOOLS","BUYING_AND_SHOPPING_SERVICES_AND_CLUBS","CABLE_SATELLITE_AND_OTHER_PAY_TELEVISION_AND_RADIO_SERVICES","CABLE_SATELLITE_AND_OTHER_PAY_TV_AND_RADIO","CAMERA_AND_PHOTOGRAPHIC_SUPPLIES","CAMERAS","CAMERAS_AND_PHOTOGRAPHY","CAMPER_RECREATIONAL_AND_UTILITY_TRAILER_DEALERS","CAMPING_AND_OUTDOORS","CAMPING_AND_SURVIVAL","CAR_AND_TRUCK_DEALERS","CAR_AND_TRUCK_DEALERS_USED_ONLY","CAR_AUDIO_AND_ELECTRONICS","CAR_RENTAL_AGENCY","CATALOG_MERCHANT","CATALOG_RETAIL_MERCHANT","CATERING_SERVICES","CHARITY","CHECK_CASHIER","CHILD_CARE_SERVICES","CHILDREN_BOOKS","CHIROPODISTS_PODIATRISTS","CHIROPRACTORS","CIGAR_STORES_AND_STANDS","CIVIC_SOCIAL_FRATERNAL_ASSOCIATIONS","CIVIL_SOCIAL_FRAT_ASSOCIATIONS","CLOTHING","CLOTHING_ACCESSORIES_AND_SHOES","CLOTHING_RENTAL","COFFEE_AND_TEA","COIN_OPERATED_BANKS_AND_CASINOS","COLLECTIBLES","COLLECTION_AGENCY","COLLEGES_AND_UNIVERSITIES","COMMERCIAL_EQUIPMENT","COMMERCIAL_FOOTWEAR","COMMERCIAL_PHOTOGRAPHY","COMMERCIAL_PHOTOGRAPHY_ART_AND_GRAPHICS","COMMERCIAL_SPORTS_PROFESSIONA","COMMODITIES_AND_FUTURES_EXCHANGE","COMPUTER_AND_DATA_PROCESSING_SERVICES","COMPUTER_HARDWARE_AND_SOFTWARE","COMPUTER_MAINTENANCE_REPAIR_AND_SERVICES_NOT_ELSEWHERE_CLAS","CONSTRUCTION","CONSTRUCTION_MATERIALS_NOT_ELSEWHERE_CLASSIFIED","CONSULTING_SERVICES","CONSUMER_CREDIT_REPORTING_AGENCIES","CONVALESCENT_HOMES","COSMETIC_STORES","COUNSELING_SERVICES_DEBT_MARRIAGE_PERSONAL","COUNTERFEIT_CURRENCY_AND_STAMPS","COUNTERFEIT_ITEMS","COUNTRY_CLUBS","COURIER_SERVICES","COURIER_SERVICES_AIR_AND_GROUND_AND_FREIGHT_FORWARDERS","COURT_COSTS_ALIMNY_CHILD_SUPT","COURT_COSTS_INCLUDING_ALIMONY_AND_CHILD_SUPPORT_COURTS_OF_LAW","CREDIT_CARDS","CREDIT_UNION","CULTURE_AND_RELIGION","DAIRY_PRODUCTS_STORES","DANCE_HALLS_STUDIOS_AND_SCHOOLS","DECORATIVE","DENTAL","DENTISTS_AND_ORTHODONTISTS","DEPARTMENT_STORES","DESKTOP_PCS","DEVICES","DIECAST_TOYS_VEHICLES","DIGITAL_GAMES","DIGITAL_MEDIA_BOOKS_MOVIES_MUSIC","DIRECT_MARKETING","DIRECT_MARKETING_CATALOG_MERCHANT","DIRECT_MARKETING_INBOUND_TELE","DIRECT_MARKETING_OUTBOUND_TELE","DIRECT_MARKETING_SUBSCRIPTION","DISCOUNT_STORES","DOOR_TO_DOOR_SALES","DRAPERY_WINDOW_COVERING_AND_UPHOLSTERY","DRINKING_PLACES","DRUGSTORE","DURABLE_GOODS","ECOMMERCE_DEVELOPMENT","ECOMMERCE_SERVICES","EDUCATIONAL_AND_TEXTBOOKS","ELECTRIC_RAZOR_STORES","ELECTRICAL_AND_SMALL_APPLIANCE_REPAIR","ELECTRICAL_CONTRACTORS","ELECTRICAL_PARTS_AND_EQUIPMENT","ELECTRONIC_CASH","ELEMENTARY_AND_SECONDARY_SCHOOLS","EMPLOYMENT","ENTERTAINERS","ENTERTAINMENT_AND_MEDIA","EQUIP_TOOL_FURNITURE_AND_APPLIANCE_RENTAL_AND_LEASING","ESCROW","EVENT_AND_WEDDING_PLANNING","EXERCISE_AND_FITNESS","EXERCISE_EQUIPMENT","EXTERMINATING_AND_DISINFECTING_SERVICES","FABRICS_AND_SEWING","FAMILY_CLOTHING_STORES","FASHION_JEWELRY","FAST_FOOD_RESTAURANTS","FICTION_AND_NONFICTION","FINANCE_COMPANY","FINANCIAL_AND_INVESTMENT_ADVICE","FINANCIAL_INSTITUTIONS_MERCHANDISE_AND_SERVICES","FIREARM_ACCESSORIES","FIREARMS_WEAPONS_AND_KNIVES","FIREPLACE_AND_FIREPLACE_SCREENS","FIREWORKS","FISHING","FLORISTS","FLOWERS","FOOD_DRINK_AND_NUTRITION","FOOD_PRODUCTS","FOOD_RETAIL_AND_SERVICE","FRAGRANCES_AND_PERFUMES","FREEZER_AND_LOCKER_MEAT_PROVISIONERS","FUEL_DEALERS_FUEL_OIL_WOOD_AND_COAL","FUEL_DEALERS_NON_AUTOMOTIVE","FUNERAL_SERVICES_AND_CREMATORIES","FURNISHING_AND_DECORATING","FURNITURE","FURRIERS_AND_FUR_SHOPS","GADGETS_AND_OTHER_ELECTRONICS","GAMBLING","GAME_SOFTWARE","GAMES","GARDEN_SUPPLIES","GENERAL","GENERAL_CONTRACTORS","GENERAL_GOVERNMENT","GENERAL_SOFTWARE","GENERAL_TELECOM","GIFTS_AND_FLOWERS","GLASS_PAINT_AND_WALLPAPER_STORES","GLASSWARE_CRYSTAL_STORES","GOVERNMENT","GOVERNMENT_IDS_AND_LICENSES","GOVERNMENT_LICENSED_ON_LINE_CASINOS_ON_LINE_GAMBLING","GOVERNMENT_OWNED_LOTTERIES","GOVERNMENT_SERVICES","GRAPHIC_AND_COMMERCIAL_DESIGN","GREETING_CARDS","GROCERY_STORES_AND_SUPERMARKETS","HARDWARE_AND_TOOLS","HARDWARE_EQUIPMENT_AND_SUPPLIES","HAZARDOUS_RESTRICTED_AND_PERISHABLE_ITEMS","HEALTH_AND_BEAUTY_SPAS","HEALTH_AND_NUTRITION","HEALTH_AND_PERSONAL_CARE","HEARING_AIDS_SALES_AND_SUPPLIES","HEATING_PLUMBING_AC","HIGH_RISK_MERCHANT","HIRING_SERVICES","HOBBIES_TOYS_AND_GAMES","HOME_AND_GARDEN","HOME_AUDIO","HOME_DECOR","HOME_ELECTRONICS","HOSPITALS","HOTELS_MOTELS_INNS_RESORTS","HOUSEWARES","HUMAN_PARTS_AND_REMAINS","HUMOROUS_GIFTS_AND_NOVELTIES","HUNTING","IDS_LICENSES_AND_PASSPORTS","ILLEGAL_DRUGS_AND_PARAPHERNALIA","INDUSTRIAL","INDUSTRIAL_AND_MANUFACTURING_SUPPLIES","INSURANCE_AUTO_AND_HOME","INSURANCE_DIRECT","INSURANCE_LIFE_AND_ANNUITY","INSURANCE_SALES_UNDERWRITING","INSURANCE_UNDERWRITING_PREMIUMS","INTERNET_AND_NETWORK_SERVICES","INTRA_COMPANY_PURCHASES","LABORATORIES_DENTAL_MEDICAL","LANDSCAPING","LANDSCAPING_AND_HORTICULTURAL_SERVICES","LAUNDRY_CLEANING_SERVICES","LEGAL","LEGAL_SERVICES_AND_ATTORNEYS","LOCAL_DELIVERY_SERVICE","LOCKSMITH","LODGING_AND_ACCOMMODATIONS","LOTTERY_AND_CONTESTS","LUGGAGE_AND_LEATHER_GOODS","LUMBER_AND_BUILDING_MATERIALS","MAGAZINES","MAINTENANCE_AND_REPAIR_SERVICES","MAKEUP_AND_COSMETICS","MANUAL_CASH_DISBURSEMENTS","MASSAGE_PARLORS","MEDICAL","MEDICAL_AND_PHARMACEUTICAL","MEDICAL_CARE","MEDICAL_EQUIPMENT_AND_SUPPLIES","MEDICAL_SERVICES","MEETING_PLANNERS","MEMBERSHIP_CLUBS_AND_ORGANIZATIONS","MEMBERSHIP_COUNTRY_CLUBS_GOLF","MEMORABILIA","MEN_AND_BOY_CLOTHING_AND_ACCESSORY_STORES","MEN_CLOTHING","MERCHANDISE","METAPHYSICAL","MILITARIA","MILITARY_AND_CIVIL_SERVICE_UNIFORMS","MISC","MISCELLANEOUS_GENERAL_SERVICES","MISCELLANEOUS_REPAIR_SHOPS_AND_RELATED_SERVICES","MODEL_KITS","MONEY_TRANSFER_MEMBER_FINANCIAL_INSTITUTION","MONEY_TRANSFER_MERCHANT","MOTION_PICTURE_THEATERS","MOTOR_FREIGHT_CARRIERS_AND_TRUCKING","MOTOR_HOME_AND_RECREATIONAL_VEHICLE_RENTAL","MOTOR_HOMES_DEALERS","MOTOR_VEHICLE_SUPPLIES_AND_NEW_PARTS","MOTORCYCLE_DEALERS","MOTORCYCLES","MOVIE","MOVIE_TICKETS","MOVING_AND_STORAGE","MULTI_LEVEL_MARKETING","MUSIC_CDS_CASSETTES_AND_ALBUMS","MUSIC_STORE_INSTRUMENTS_AND_SHEET_MUSIC","NETWORKING","NEW_AGE","NEW_PARTS_AND_SUPPLIES_MOTOR_VEHICLE","NEWS_DEALERS_AND_NEWSTANDS","NON_DURABLE_GOODS","NON_FICTION","NON_PROFIT_POLITICAL_AND_RELIGION","NONPROFIT","NOVELTIES","OEM_SOFTWARE","OFFICE_SUPPLIES_AND_EQUIPMENT","ONLINE_DATING","ONLINE_GAMING","ONLINE_GAMING_CURRENCY","ONLINE_SERVICES","OOUTBOUND_TELEMARKETING_MERCH","OPHTHALMOLOGISTS_OPTOMETRIST","OPTICIANS_AND_DISPENSING","ORTHOPEDIC_GOODS_PROSTHETICS","OSTEOPATHS","OTHER","PACKAGE_TOUR_OPERATORS","PAINTBALL","PAINTS_VARNISHES_AND_SUPPLIES","PARKING_LOTS_AND_GARAGES","PARTS_AND_ACCESSORIES","PAWN_SHOPS","PAYCHECK_LENDER_OR_CASH_ADVANCE","PERIPHERALS","PERSONALIZED_GIFTS","PET_SHOPS_PET_FOOD_AND_SUPPLIES","PETROLEUM_AND_PETROLEUM_PRODUCTS","PETS_AND_ANIMALS","PHOTOFINISHING_LABORATORIES_PHOTO_DEVELOPING","PHOTOGRAPHIC_STUDIOS_PORTRAITS","PHOTOGRAPHY","PHYSICAL_GOOD","PICTURE_VIDEO_PRODUCTION","PIECE_GOODS_NOTIONS_AND_OTHER_DRY_GOODS","PLANTS_AND_SEEDS","PLUMBING_AND_HEATING_EQUIPMENTS_AND_SUPPLIES","POLICE_RELATED_ITEMS","POLITICAL_ORGANIZATIONS","POSTAL_SERVICES_GOVERNMENT_ONLY","POSTERS","PREPAID_AND_STORED_VALUE_CARDS","PRESCRIPTION_DRUGS","PROMOTIONAL_ITEMS","PUBLIC_WAREHOUSING_AND_STORAGE","PUBLISHING_AND_PRINTING","PUBLISHING_SERVICES","RADAR_DECTORS","RADIO_TELEVISION_AND_STEREO_REPAIR","REAL_ESTATE","REAL_ESTATE_AGENT","REAL_ESTATE_AGENTS_AND_MANAGERS_RENTALS","RELIGION_AND_SPIRITUALITY_FOR_PROFIT","RELIGIOUS","RELIGIOUS_ORGANIZATIONS","REMITTANCE","RENTAL_PROPERTY_MANAGEMENT","RESIDENTIAL","RETAIL","RETAIL_FINE_JEWELRY_AND_WATCHES","REUPHOLSTERY_AND_FURNITURE_REPAIR","RINGS","ROOFING_SIDING_SHEET_METAL","RUGS_AND_CARPETS","SCHOOLS_AND_COLLEGES","SCIENCE_FICTION","SCRAPBOOKING","SCULPTURES","SECURITIES_BROKERS_AND_DEALERS","SECURITY_AND_SURVEILLANCE","SECURITY_AND_SURVEILLANCE_EQUIPMENT","SECURITY_BROKERS_AND_DEALERS","SEMINARS","SERVICE_STATIONS","SERVICES","SEWING_NEEDLEWORK_FABRIC_AND_PIECE_GOODS_STORES","SHIPPING_AND_PACKING","SHOE_REPAIR_HAT_CLEANING","SHOE_STORES","SHOES","SNOWMOBILE_DEALERS","SOFTWARE","SPECIALTY_AND_MISC","SPECIALTY_CLEANING_POLISHING_AND_SANITATION_PREPARATIONS","SPECIALTY_OR_RARE_PETS","SPORT_GAMES_AND_TOYS","SPORTING_AND_RECREATIONAL_CAMPS","SPORTING_GOODS","SPORTS_AND_OUTDOORS","SPORTS_AND_RECREATION","STAMP_AND_COIN","STATIONARY_PRINTING_AND_WRITING_PAPER","STENOGRAPHIC_AND_SECRETARIAL_SUPPORT_SERVICES","STOCKS_BONDS_SECURITIES_AND_RELATED_CERTIFICATES","STORED_VALUE_CARDS","SUPPLIES","SUPPLIES_AND_TOYS","SURVEILLANCE_EQUIPMENT","SWIMMING_POOLS_AND_SPAS","SWIMMING_POOLS_SALES_SUPPLIES_SERVICES","TAILORS_AND_ALTERATIONS","TAX_PAYMENTS","TAX_PAYMENTS_GOVERNMENT_AGENCIES","TAXICABS_AND_LIMOUSINES","TELECOMMUNICATION_SERVICES","TELEPHONE_CARDS","TELEPHONE_EQUIPMENT","TELEPHONE_SERVICES","THEATER","TIRE_RETREADING_AND_REPAIR","TOLL_OR_BRIDGE_FEES","TOOLS_AND_EQUIPMENT","TOURIST_ATTRACTIONS_AND_EXHIBITS","TOWING_SERVICE","TOYS_AND_GAMES","TRADE_AND_VOCATIONAL_SCHOOLS","TRADEMARK_INFRINGEMENT","TRAILER_PARKS_AND_CAMPGROUNDS","TRAINING_SERVICES","TRANSPORTATION_SERVICES","TRAVEL","TRUCK_AND_UTILITY_TRAILER_RENTALS","TRUCK_STOP","TYPESETTING_PLATE_MAKING_AND_RELATED_SERVICES","USED_MERCHANDISE_AND_SECONDHAND_STORES","USED_PARTS_MOTOR_VEHICLE","UTILITIES","UTILITIES_ELECTRIC_GAS_WATER_SANITARY","VARIETY_STORES","VEHICLE_SALES","VEHICLE_SERVICE_AND_ACCESSORIES","VIDEO_EQUIPMENT","VIDEO_GAME_ARCADES_ESTABLISH","VIDEO_GAMES_AND_SYSTEMS","VIDEO_TAPE_RENTAL_STORES","VINTAGE_AND_COLLECTIBLE_VEHICLES","VINTAGE_AND_COLLECTIBLES","VITAMINS_AND_SUPPLEMENTS","VOCATIONAL_AND_TRADE_SCHOOLS","WATCH_CLOCK_AND_JEWELRY_REPAIR","WEB_HOSTING_AND_DESIGN","WELDING_REPAIR","WHOLESALE_CLUBS","WHOLESALE_FLORIST_SUPPLIERS","WHOLESALE_PRESCRIPTION_DRUGS","WILDLIFE_PRODUCTS","WIRE_TRANSFER","WIRE_TRANSFER_AND_MONEY_ORDER","WOMEN_ACCESSORY_SPECIALITY","WOMEN_CLOTHING"]},"imageUrl":{"maxLength":2000,"minLength":1,"type":"string","description":"The home page URL for the product"},"homeUrl":{"maxLength":2000,"minLength":1,"type":"string","description":"The image URL for the product"}}}}}}
```

## The Model19 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model19":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Shipping charges amount"}}}}
```

## The paymentMethod object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"paymentMethod":{"type":"object","properties":{"payerSelected":{"type":"string","description":"The customer-selected payment method on the merchant site"},"payeePreferred":{"type":"string","description":"The merchant-preferred payment methods","enum":["UNRESTRICTED","IMMEDIATE_PAYMENT_REQUIRED"]}},"description":"The customer and merchant payment preferences. Currently only PAYPAL payment method is supported"}}}}
```

## The applicationContext object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"applicationContext":{"type":"object","properties":{"brandName":{"type":"string","description":"The label that overrides the business name in the PayPal account on the PayPal site"},"locale":{"type":"string","description":"The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW"},"shippingPreference":{"type":"string","description":"The location from which the shipping address is derived","enum":["GET_FROM_FILE","NO_SHIPPING","SET_PROVIDED_ADDRESS"]},"userAction":{"type":"string","description":"Configures the label name to Continue or Subscribe Now for subscription consent experience","enum":["CONTINUE","SUBSCRIBE_NOW"]},"paymentMethod":{"$ref":"#/components/schemas/paymentMethod"},"returnUrl":{"type":"string","description":"The URL where the customer is redirected after the customer approves the payment"},"cancelUrl":{"type":"string","description":"The URL where the customer is redirected after the customer cancels the payment"}},"description":"The application context, which customizes the payer experience during the subscription approval process with PayPal"},"paymentMethod":{"type":"object","properties":{"payerSelected":{"type":"string","description":"The customer-selected payment method on the merchant site"},"payeePreferred":{"type":"string","description":"The merchant-preferred payment methods","enum":["UNRESTRICTED","IMMEDIATE_PAYMENT_REQUIRED"]}},"description":"The customer and merchant payment preferences. Currently only PAYPAL payment method is supported"}}}}
```

## The Model20 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model20":{"required":["paymentProviderContract","planId"],"type":"object","properties":{"paymentProviderContract":{"type":"string","description":"PayPal Payment Provider Contract UUID"},"planId":{"maxLength":50,"minLength":3,"type":"string","description":"The ID of the plan"},"startTime":{"type":"string","description":"The date and time when the subscription started","format":"date"},"quantity":{"type":"integer","description":"The quantity of the product in the subscription"},"shippingAmount":{"$ref":"#/components/schemas/Model19"},"subscriber":{"$ref":"#/components/schemas/subscriber"},"customId":{"maxLength":127,"minLength":1,"pattern":"^[ -~]+","type":"string","description":"The custom id for the subscription. Can be invoice id"},"applicationContext":{"$ref":"#/components/schemas/applicationContext"}}},"Model19":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Shipping charges amount"},"subscriber":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/name"},"payerId":{"pattern":"^[2-9A-HJ-NP-Z]{13}$","type":"string","description":"The PayPal-assigned ID for the payer"},"emailAddress":{"maxLength":255,"type":"string","description":"Customer email address"},"phone":{"$ref":"#/components/schemas/phone"},"shippingAddress":{"$ref":"#/components/schemas/Model12"}},"description":"The subscriber request information"},"name":{"type":"object","properties":{"givenName":{"maxLength":140,"type":"string"},"surname":{"maxLength":140,"type":"string"}},"description":"The name of the payer"},"phone":{"required":["phoneNumber"],"type":"object","properties":{"phoneType":{"type":"string","description":"The phone type","enum":["FAX","HOME","MOBILE","OTHER","PAGER"]},"phoneNumber":{"$ref":"#/components/schemas/phoneNumber"}},"description":"The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account"},"phoneNumber":{"required":["nationalNumber"],"type":"object","properties":{"nationalNumber":{"maxLength":14,"minLength":1,"pattern":"^[0-9]{1,14}?$","type":"string"}},"description":"The phone number, in its canonical international E.164 numbering plan format"},"Model12":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Model11"},"address":{"$ref":"#/components/schemas/billingAddress"}},"description":"The shipping details"},"Model11":{"type":"object","properties":{"fullName":{"maxLength":300,"type":"string"}},"description":"The name of the person to whom to ship the items"},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"},"applicationContext":{"type":"object","properties":{"brandName":{"type":"string","description":"The label that overrides the business name in the PayPal account on the PayPal site"},"locale":{"type":"string","description":"The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW"},"shippingPreference":{"type":"string","description":"The location from which the shipping address is derived","enum":["GET_FROM_FILE","NO_SHIPPING","SET_PROVIDED_ADDRESS"]},"userAction":{"type":"string","description":"Configures the label name to Continue or Subscribe Now for subscription consent experience","enum":["CONTINUE","SUBSCRIBE_NOW"]},"paymentMethod":{"$ref":"#/components/schemas/paymentMethod"},"returnUrl":{"type":"string","description":"The URL where the customer is redirected after the customer approves the payment"},"cancelUrl":{"type":"string","description":"The URL where the customer is redirected after the customer cancels the payment"}},"description":"The application context, which customizes the payer experience during the subscription approval process with PayPal"},"paymentMethod":{"type":"object","properties":{"payerSelected":{"type":"string","description":"The customer-selected payment method on the merchant site"},"payeePreferred":{"type":"string","description":"The merchant-preferred payment methods","enum":["UNRESTRICTED","IMMEDIATE_PAYMENT_REQUIRED"]}},"description":"The customer and merchant payment preferences. Currently only PAYPAL payment method is supported"}}}}
```

## The Model21 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model21":{"required":["approvalUrl","id","planId","planOverridden","status","statusUpdateTime"],"type":"object","properties":{"id":{"type":"string","description":"The PayPal-generated ID for the subscription."},"status":{"type":"string","description":"The status of the subscription."},"planId":{"maxLength":50,"minLength":3,"type":"string","description":"The ID of the plan"},"statusUpdateTime":{"type":"string","description":"Status update time.","format":"date"},"planOverridden":{"type":"boolean","description":"Indicates whether the subscription has overridden any plan attributes."},"quantity":{"type":"string","description":"The quantity of the product in the subscription."},"startTime":{"type":"string","description":"The quantity of the product in the subscription.","format":"date"},"shippingAmount":{"$ref":"#/components/schemas/Model19"},"subscriber":{"$ref":"#/components/schemas/subscriber"},"applicationContext":{"$ref":"#/components/schemas/applicationContext"},"createdAt":{"type":"string","description":"The quantity of the product in the subscription.","format":"date"},"approvalUrl":{"type":"string","description":"PayPal approval URL"}}},"Model19":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Shipping charges amount"},"subscriber":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/name"},"payerId":{"pattern":"^[2-9A-HJ-NP-Z]{13}$","type":"string","description":"The PayPal-assigned ID for the payer"},"emailAddress":{"maxLength":255,"type":"string","description":"Customer email address"},"phone":{"$ref":"#/components/schemas/phone"},"shippingAddress":{"$ref":"#/components/schemas/Model12"}},"description":"The subscriber request information"},"name":{"type":"object","properties":{"givenName":{"maxLength":140,"type":"string"},"surname":{"maxLength":140,"type":"string"}},"description":"The name of the payer"},"phone":{"required":["phoneNumber"],"type":"object","properties":{"phoneType":{"type":"string","description":"The phone type","enum":["FAX","HOME","MOBILE","OTHER","PAGER"]},"phoneNumber":{"$ref":"#/components/schemas/phoneNumber"}},"description":"The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account"},"phoneNumber":{"required":["nationalNumber"],"type":"object","properties":{"nationalNumber":{"maxLength":14,"minLength":1,"pattern":"^[0-9]{1,14}?$","type":"string"}},"description":"The phone number, in its canonical international E.164 numbering plan format"},"Model12":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Model11"},"address":{"$ref":"#/components/schemas/billingAddress"}},"description":"The shipping details"},"Model11":{"type":"object","properties":{"fullName":{"maxLength":300,"type":"string"}},"description":"The name of the person to whom to ship the items"},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"},"applicationContext":{"type":"object","properties":{"brandName":{"type":"string","description":"The label that overrides the business name in the PayPal account on the PayPal site"},"locale":{"type":"string","description":"The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW"},"shippingPreference":{"type":"string","description":"The location from which the shipping address is derived","enum":["GET_FROM_FILE","NO_SHIPPING","SET_PROVIDED_ADDRESS"]},"userAction":{"type":"string","description":"Configures the label name to Continue or Subscribe Now for subscription consent experience","enum":["CONTINUE","SUBSCRIBE_NOW"]},"paymentMethod":{"$ref":"#/components/schemas/paymentMethod"},"returnUrl":{"type":"string","description":"The URL where the customer is redirected after the customer approves the payment"},"cancelUrl":{"type":"string","description":"The URL where the customer is redirected after the customer cancels the payment"}},"description":"The application context, which customizes the payer experience during the subscription approval process with PayPal"},"paymentMethod":{"type":"object","properties":{"payerSelected":{"type":"string","description":"The customer-selected payment method on the merchant site"},"payeePreferred":{"type":"string","description":"The merchant-preferred payment methods","enum":["UNRESTRICTED","IMMEDIATE_PAYMENT_REQUIRED"]}},"description":"The customer and merchant payment preferences. Currently only PAYPAL payment method is supported"}}}}
```

## The Model22 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model22":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Total transaction amount"}}}}
```

## The Phone\_number object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Phone_number":{"required":["value"],"type":"object","properties":{"phoneType":{"type":"string","description":"Customer phone type","enum":["FAX","HOME","MOBILE","OTHER","PAGER"]},"value":{"type":"string","description":"Customer phone number"}},"description":"Phone number"}}}}
```

## The identification object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"identification":{"required":["taxIdentificationNumber","taxIdentificationType"],"type":"object","properties":{"taxIdentificationNumber":{"maxLength":14,"type":"string","description":"Customer tax ID. Supported for the PayPal payment method only. Typically, the tax ID is 11 characters long for individuals and 14 characters long for businesses."},"taxIdentificationType":{"type":"string","description":"The customer tax ID type.","enum":["BR_CNPJ","BR_CPF"]}},"description":"Customer identification"}}}}
```

## The address object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"address":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Customer billing address"}}}}
```

## The customer object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"customer":{"type":"object","properties":{"email":{"maxLength":255,"type":"string","description":"Customer email address"},"payerId":{"pattern":"^[2-9A-HJ-NP-Z]{13}$","type":"string","description":"The PayPal-assigned ID for the payer"},"phoneNumber":{"$ref":"#/components/schemas/Phone_number"},"birthDate":{"type":"string","description":"Date of birth of the customer, 10 characters, ISO-8601 (YYYY-MM-DD)","format":"date"},"identification":{"$ref":"#/components/schemas/identification"},"address":{"$ref":"#/components/schemas/address"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"}},"description":"Customer details"},"Phone_number":{"required":["value"],"type":"object","properties":{"phoneType":{"type":"string","description":"Customer phone type","enum":["FAX","HOME","MOBILE","OTHER","PAGER"]},"value":{"type":"string","description":"Customer phone number"}},"description":"Phone number"},"identification":{"required":["taxIdentificationNumber","taxIdentificationType"],"type":"object","properties":{"taxIdentificationNumber":{"maxLength":14,"type":"string","description":"Customer tax ID. Supported for the PayPal payment method only. Typically, the tax ID is 11 characters long for individuals and 14 characters long for businesses."},"taxIdentificationType":{"type":"string","description":"The customer tax ID type.","enum":["BR_CNPJ","BR_CPF"]}},"description":"Customer identification"},"address":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Customer billing address"}}}}
```

## The application\_context object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"application_context":{"type":"object","properties":{"brandName":{"maxLength":127,"type":"string","description":"The label that overrides the business name in the PayPal account on the PayPal site."},"locale":{"maxLength":127,"type":"string","description":"The BCP 47-formatted locale of pages that the PayPal payment experience shows.   PayPal supports a five-character code.  For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW."},"landingPage":{"type":"string","description":"The    type of landing page to show on the PayPal site for customer checkout. default will be NO_PREFERENCE Possible Values: <br />  * BILLING - When the customer clicks PayPal Checkout, the customer is redirected to a page to log in to PayPal and approve the payment. <br />  * LOGIN - When the customer clicks PayPal Checkout, the customer is redirected to a page to enter credit or debit card and other relevant billing information required to complete the purchase. <br />  * NO_PREFERENCE - When the customer clicks PayPal Checkout, the customer is redirected to either a page to log in to PayPal and approve the payment or to a page to enter credit or debit card and other relevant billing information required to complete the purchase, depending on their previous interaction with PayPal. <br />","enum":["BILLING","LOGIN","NO_PREFERENCE"]},"shippingPreference":{"type":"string","description":"The shipping preference:\n* Redact the shipping address from the PayPal site. Recommended for digital goods.\n* Use the customer-provided shipping address on the PayPal site.\n* Use the merchant-provided address. The customer cannot change this address on the PayPal site.","enum":["NoShipping","CustomerProvided","MerchantProvided"]},"paymentPreference":{"type":"string","description":"The merchant-preferred payment methods:\n* Accepts any type of payment from the customer.\n* Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH.","enum":["Any","Immediate"]},"shopperAuthorization":{"type":"string","description":"NACHA (the regulatory body governing the ACH network) requires that API callers (merchants, partners) obtain the consumer’s explicit authorization before initiating a transaction. ACH transactions are categorized (using SEC codes) by how you capture authorization from the Receiver (the person whose bank account is being debited or credited). PayPal supports the following SEC codes.\n* <b>TEL.</b> The API caller (merchant/partner) accepts authorization and payment information from a consumer over the telephone.\n* <b>WEB.</b> The API caller (merchant/partner) accepts Debit transactions from a consumer on their website.\n* <b>CCD.</b> Cash concentration and disbursement for corporate debit transaction. Used to disburse or consolidate funds. Entries are usually Optional high-dollar, low-volume, and time-critical. (e.g. intra-company transfers or invoice payments to suppliers).\n* <b>PPD.</b> Prearranged payment and deposit entries. Used for debit payments authorized by a consumer account holder, and usually initiated by a company. These are usually recurring debits (such as insurance premiums).","enum":["TEL","WEB","CCD","PPD"]},"returnUrl":{"type":"string","description":"The URL where the customer is redirected after the customer approves the payment"},"cancelUrl":{"type":"string","description":"The URL where the customer is redirected after the customer cancels the payment"}},"description":"Application context details"}}}}
```

## The shipping object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"shipping":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/billingAddress"},"fullName":{"type":"string","description":"Full Name"}},"description":"Shipping details"},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"}}}}
```

## The unitAmount object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"unitAmount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"Amount for the item"}}}}
```

## The tax object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"tax":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"Tax amount"}}}}
```

## The Model24 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model24":{"required":["tax","unitAmount"],"type":"object","properties":{"name":{"maxLength":127,"type":"string","description":"Item name"},"unitAmount":{"$ref":"#/components/schemas/unitAmount"},"tax":{"$ref":"#/components/schemas/tax"},"quantity":{"type":"number","description":"Item quantity"},"description":{"maxLength":127,"type":"string","description":"Item description"},"sku":{"maxLength":127,"type":"string","description":"The Stock Keeping Unit"},"category":{"type":"string","description":"Category of Goods","enum":["DIGITAL_GOODS","PHYSICAL_GOODS"]}}},"unitAmount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"Amount for the item"},"tax":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"Tax amount"}}}}
```

## The items object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"items":{"type":"array","description":"Items to purchase","items":{"$ref":"#/components/schemas/Model24"}},"Model24":{"required":["tax","unitAmount"],"type":"object","properties":{"name":{"maxLength":127,"type":"string","description":"Item name"},"unitAmount":{"$ref":"#/components/schemas/unitAmount"},"tax":{"$ref":"#/components/schemas/tax"},"quantity":{"type":"number","description":"Item quantity"},"description":{"maxLength":127,"type":"string","description":"Item description"},"sku":{"maxLength":127,"type":"string","description":"The Stock Keeping Unit"},"category":{"type":"string","description":"Category of Goods","enum":["DIGITAL_GOODS","PHYSICAL_GOODS"]}}},"unitAmount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"Amount for the item"},"tax":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"Tax amount"}}}}
```

## The discount object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"discount":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Discount amount"}}}}
```

## The shippingDiscount object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"shippingDiscount":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Shipping discount amount"}}}}
```

## The insurance object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"insurance":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Insurance fee amount"}}}}
```

## The handling object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"handling":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Handling fee amount"}}}}
```

## The Model25 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model25":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Shipping fee amount"}}}}
```

## The detailedAmount object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"detailedAmount":{"type":"object","properties":{"discount":{"$ref":"#/components/schemas/discount"},"shippingDiscount":{"$ref":"#/components/schemas/shippingDiscount"},"insurance":{"$ref":"#/components/schemas/insurance"},"handling":{"$ref":"#/components/schemas/handling"},"shipping":{"$ref":"#/components/schemas/Model25"}},"description":"Detailed amount"},"discount":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Discount amount"},"shippingDiscount":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Shipping discount amount"},"insurance":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Insurance fee amount"},"handling":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Handling fee amount"},"Model25":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Shipping fee amount"}}}}
```

## The Model26 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model26":{"required":["amount","paymentProviderContract"],"type":"object","properties":{"paymentProviderContract":{"type":"string","description":"Payment Provider contract"},"amount":{"$ref":"#/components/schemas/Model22"},"intent":{"type":"string","description":"Intent of this transaction","default":"CAPTURE","enum":["AUTHORIZE","CAPTURE"]},"customer":{"$ref":"#/components/schemas/customer"},"applicationContext":{"$ref":"#/components/schemas/application_context"},"shipping":{"$ref":"#/components/schemas/shipping"},"items":{"$ref":"#/components/schemas/items"},"dynamicDescriptor":{"maxLength":22,"type":"string","description":"If an Order is paid using the \"PayPal Wallet\" the statement descriptor will appear in following format on the payer card statement:  PAYPAL_prefix+(space)+merchant_descriptor+(space)+dynamicDescriptor.  The PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the statement. <br />  For example, <br/>  * The PayPal prefix toggle is PAYPAL <br/>  * The merchant descriptor in the profile is Janes Gift <br/>  * The soft descriptor is 800-123-1234 </br> Then, the statement descriptor on the card is PAYPAL * Janes Gift 80."},"merchantReference":{"maxLength":127,"type":"string","description":"The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer."},"description":{"maxLength":127,"type":"string","description":"Purchase description"},"detailedAmount":{"$ref":"#/components/schemas/detailedAmount"}}},"Model22":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Total transaction amount"},"customer":{"type":"object","properties":{"email":{"maxLength":255,"type":"string","description":"Customer email address"},"payerId":{"pattern":"^[2-9A-HJ-NP-Z]{13}$","type":"string","description":"The PayPal-assigned ID for the payer"},"phoneNumber":{"$ref":"#/components/schemas/Phone_number"},"birthDate":{"type":"string","description":"Date of birth of the customer, 10 characters, ISO-8601 (YYYY-MM-DD)","format":"date"},"identification":{"$ref":"#/components/schemas/identification"},"address":{"$ref":"#/components/schemas/address"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"}},"description":"Customer details"},"Phone_number":{"required":["value"],"type":"object","properties":{"phoneType":{"type":"string","description":"Customer phone type","enum":["FAX","HOME","MOBILE","OTHER","PAGER"]},"value":{"type":"string","description":"Customer phone number"}},"description":"Phone number"},"identification":{"required":["taxIdentificationNumber","taxIdentificationType"],"type":"object","properties":{"taxIdentificationNumber":{"maxLength":14,"type":"string","description":"Customer tax ID. Supported for the PayPal payment method only. Typically, the tax ID is 11 characters long for individuals and 14 characters long for businesses."},"taxIdentificationType":{"type":"string","description":"The customer tax ID type.","enum":["BR_CNPJ","BR_CPF"]}},"description":"Customer identification"},"address":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Customer billing address"},"application_context":{"type":"object","properties":{"brandName":{"maxLength":127,"type":"string","description":"The label that overrides the business name in the PayPal account on the PayPal site."},"locale":{"maxLength":127,"type":"string","description":"The BCP 47-formatted locale of pages that the PayPal payment experience shows.   PayPal supports a five-character code.  For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW."},"landingPage":{"type":"string","description":"The    type of landing page to show on the PayPal site for customer checkout. default will be NO_PREFERENCE Possible Values: <br />  * BILLING - When the customer clicks PayPal Checkout, the customer is redirected to a page to log in to PayPal and approve the payment. <br />  * LOGIN - When the customer clicks PayPal Checkout, the customer is redirected to a page to enter credit or debit card and other relevant billing information required to complete the purchase. <br />  * NO_PREFERENCE - When the customer clicks PayPal Checkout, the customer is redirected to either a page to log in to PayPal and approve the payment or to a page to enter credit or debit card and other relevant billing information required to complete the purchase, depending on their previous interaction with PayPal. <br />","enum":["BILLING","LOGIN","NO_PREFERENCE"]},"shippingPreference":{"type":"string","description":"The shipping preference:\n* Redact the shipping address from the PayPal site. Recommended for digital goods.\n* Use the customer-provided shipping address on the PayPal site.\n* Use the merchant-provided address. The customer cannot change this address on the PayPal site.","enum":["NoShipping","CustomerProvided","MerchantProvided"]},"paymentPreference":{"type":"string","description":"The merchant-preferred payment methods:\n* Accepts any type of payment from the customer.\n* Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH.","enum":["Any","Immediate"]},"shopperAuthorization":{"type":"string","description":"NACHA (the regulatory body governing the ACH network) requires that API callers (merchants, partners) obtain the consumer’s explicit authorization before initiating a transaction. ACH transactions are categorized (using SEC codes) by how you capture authorization from the Receiver (the person whose bank account is being debited or credited). PayPal supports the following SEC codes.\n* <b>TEL.</b> The API caller (merchant/partner) accepts authorization and payment information from a consumer over the telephone.\n* <b>WEB.</b> The API caller (merchant/partner) accepts Debit transactions from a consumer on their website.\n* <b>CCD.</b> Cash concentration and disbursement for corporate debit transaction. Used to disburse or consolidate funds. Entries are usually Optional high-dollar, low-volume, and time-critical. (e.g. intra-company transfers or invoice payments to suppliers).\n* <b>PPD.</b> Prearranged payment and deposit entries. Used for debit payments authorized by a consumer account holder, and usually initiated by a company. These are usually recurring debits (such as insurance premiums).","enum":["TEL","WEB","CCD","PPD"]},"returnUrl":{"type":"string","description":"The URL where the customer is redirected after the customer approves the payment"},"cancelUrl":{"type":"string","description":"The URL where the customer is redirected after the customer cancels the payment"}},"description":"Application context details"},"shipping":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/billingAddress"},"fullName":{"type":"string","description":"Full Name"}},"description":"Shipping details"},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"},"items":{"type":"array","description":"Items to purchase","items":{"$ref":"#/components/schemas/Model24"}},"Model24":{"required":["tax","unitAmount"],"type":"object","properties":{"name":{"maxLength":127,"type":"string","description":"Item name"},"unitAmount":{"$ref":"#/components/schemas/unitAmount"},"tax":{"$ref":"#/components/schemas/tax"},"quantity":{"type":"number","description":"Item quantity"},"description":{"maxLength":127,"type":"string","description":"Item description"},"sku":{"maxLength":127,"type":"string","description":"The Stock Keeping Unit"},"category":{"type":"string","description":"Category of Goods","enum":["DIGITAL_GOODS","PHYSICAL_GOODS"]}}},"unitAmount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"Amount for the item"},"tax":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"Tax amount"},"detailedAmount":{"type":"object","properties":{"discount":{"$ref":"#/components/schemas/discount"},"shippingDiscount":{"$ref":"#/components/schemas/shippingDiscount"},"insurance":{"$ref":"#/components/schemas/insurance"},"handling":{"$ref":"#/components/schemas/handling"},"shipping":{"$ref":"#/components/schemas/Model25"}},"description":"Detailed amount"},"discount":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Discount amount"},"shippingDiscount":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Shipping discount amount"},"insurance":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Insurance fee amount"},"handling":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Handling fee amount"},"Model25":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Shipping fee amount"}}}}
```

## The Payer\_Name object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Payer_Name":{"type":"object","description":"The name of the payer.","properties":{"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"}}}}}}
```

## The Shipping-Address object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Shipping-Address":{"type":"object","description":"Shipping Address details","properties":{"country":{"type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region.","minLength":2,"maxLength":2,"pattern":"^([A-Z]{2}|C2)$"},"postalCode":{"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent.","maxLength":60},"countrySubdivision":{"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.","maxLength":300},"city":{"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1","maxLength":120},"addressLine2":{"type":"string","description":"The second line of the address. For example, suite or apartment number.","maxLength":300},"addressLine1":{"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.","maxLength":300},"fullName":{"type":"string","description":"The name of the person to whom to ship the items."}},"required":["country","postalCode"]}}}}
```

## The Model27 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model27":{"type":"object","properties":{"payerId":{"pattern":"^[2-9A-HJ-NP-Z]{13}$","type":"string","description":"The PayPal-assigned ID for the payer"},"name":{"$ref":"#/components/schemas/Payer_Name"},"phoneNumber":{"$ref":"#/components/schemas/Phone_number"},"email":{"type":"string","description":"The email address of the payer.","maxLength":255},"shippingAddress":{"$ref":"#/components/schemas/billingAddress"}}},"Payer_Name":{"type":"object","description":"The name of the payer.","properties":{"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"}}},"Phone_number":{"required":["value"],"type":"object","properties":{"phoneType":{"type":"string","description":"Customer phone type","enum":["FAX","HOME","MOBILE","OTHER","PAGER"]},"value":{"type":"string","description":"Customer phone number"}},"description":"Phone number"},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"}}}}
```

## The Model28 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model28":{"required":["createdAt","id","instoreReference"],"type":"object","properties":{"id":{"type":"string","description":"Transaction UUID from create transaction API"},"createdAt":{"type":"string","description":"Transaction creation date (ISO-8601)","format":"date"},"status":{"type":"string","description":"Transaction status","enum":["INITIATED","AUTHORISED"]},"orderId":{"type":"string","description":"PayPal order identifier"},"instoreReference":{"type":"string","description":"Reference to the transaction for internal usage for instore"},"approvalUrl":{"type":"string","description":"The URL where the customer should be redirected to approve the payment"}}}}}}
```

## The Model29 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model29":{"required":["billingToken","paymentProviderContract"],"type":"object","properties":{"billingToken":{"type":"string","description":"PayPal agreement token"},"paymentProviderContract":{"type":"string","description":"PayPal Payment Provider Contract UUID"}}}}}}
```

## The Model30 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model30":{"required":["createTime","id","state"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the agreement."},"state":{"type":"string","description":"The state of the agreement."},"description":{"type":"string","description":"The description of the agreement."},"merchant":{"$ref":"#/components/schemas/merchant"},"payer":{"$ref":"#/components/schemas/payer"},"plan":{"$ref":"#/components/schemas/plan"},"createTime":{"type":"string","description":"The date and time when the agreement was created."},"updateTime":{"type":"string","description":"The date and time when the agreement was updated."}}},"merchant":{"type":"object","properties":{"payeeInfo":{"$ref":"#/components/schemas/payeeInfo"}}},"payeeInfo":{"required":["email"],"type":"object","properties":{"email":{"type":"string","description":"The email address that is associated with the payee's PayPal account."}}},"payer":{"type":"object","properties":{"payerInfo":{"$ref":"#/components/schemas/payerInfo"}}},"payerInfo":{"required":["email","payerId"],"type":"object","properties":{"email":{"type":"string","description":"The payer's email address."},"suffix":{"type":"string","description":"The payer's name suffix."},"firstName":{"type":"string","description":"The payer's first name."},"lastName":{"type":"string","description":"The payer's last name."},"payerId":{"type":"string","description":"The PayPal-assigned payer ID."},"phone":{"type":"string","description":"The payer's phone number."},"billingAddress":{"$ref":"#/components/schemas/billingAddress"}}},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"},"plan":{"type":"object","properties":{"merchantPreferences":{"$ref":"#/components/schemas/merchantPreferences"}}},"merchantPreferences":{"type":"object","properties":{"collectShippingAddress":{"type":"string","description":"Indicates whether to skip the collection of the shipping address from the customer during the agreement sign-up phase."},"enableAddressChange":{"type":"string","description":"Indicates whether to show the shipping address but prevent the customer from editing it."},"experienceId":{"type":"string","description":"The ID of the experience profile to apply during the agreement approval UI flow."},"externalSelectedFundingInstrumentType":{"type":"string","description":"The type of financial instrument (FI) that the merchant wants to promote."},"allowedCountries":{"$ref":"#/components/schemas/allowedCountries"}}},"allowedCountries":{"type":"array","description":"An array of legally accepted customer country codes","items":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."}}}}}
```

## The Model31 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model31":{"required":["addressLine1","city","country","countrySubdivision","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"}}}}
```

## The Model32 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model32":{"required":["paymentProviderContract"],"type":"object","properties":{"paymentProviderContract":{"type":"string","description":"PayPal Payment Provider Contract UUID"},"description":{"type":"string","description":"Agreement description"},"shippingAddress":{"$ref":"#/components/schemas/Model31"},"enableAddressChange":{"type":"boolean","description":"Indicates whether to show the shipping address but prevent the customer from editing it."},"collectShippingAddress":{"type":"boolean","description":"Indicates whether to skip the collection of the shipping address from the customer during the agreement sign-up phase."},"allowedCountries":{"$ref":"#/components/schemas/allowedCountries"},"experienceId":{"type":"string","description":"The ID of the experience profile to apply during the agreement approval UI flow."},"externalSelectedFundingInstrumentType":{"type":"string","description":"The type of financial instrument (FI) that the merchant wants to promote.","enum":["CREDIT","PAY_UPON_INVOICE"]},"returnUrl":{"type":"string","description":"The URL where the customer is redirected after the customer approves the payment"},"cancelUrl":{"type":"string","description":"The URL where the customer is redirected after the customer cancels the payment"}}},"Model31":{"required":["addressLine1","city","country","countrySubdivision","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"},"allowedCountries":{"type":"array","description":"An array of legally accepted customer country codes","items":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."}}}}}
```

## The Model33 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model33":{"required":["approvalUrl","billingToken"],"type":"object","properties":{"approvalUrl":{"type":"string","description":"PayPal approval URL"},"billingToken":{"type":"string","description":"Billing token"}}}}}}
```

## The Model34 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model34":{"required":["sequence","tenureType"],"type":"object","properties":{"pricingScheme":{"$ref":"#/components/schemas/pricingScheme"},"frequency":{"$ref":"#/components/schemas/frequency"},"tenureType":{"type":"string","description":"The tenure type of the billing cycle.","enum":["REGULAR","TRIAL"]},"sequence":{"type":"number","description":"The order in which this cycle is to run among other billing cycles."},"totalCycles":{"type":"number","description":"The number of times this billing cycle gets executed."}}},"pricingScheme":{"type":"object","properties":{"version":{"maximum":999,"type":"number","description":"The version of the pricing scheme."},"fixedPrice":{"$ref":"#/components/schemas/fixedPrice"},"pricingModel":{"type":"string","description":"The pricing model for tiered plan","enum":["VOLUME","TIERED"]},"tiers":{"$ref":"#/components/schemas/tiers"}},"description":"The active pricing scheme for this billing cycle."},"fixedPrice":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The fixed amount to charge for the subscription"},"tiers":{"type":"array","description":"An array of pricing tiers which are used for billing volume/tiered plans.","items":{"$ref":"#/components/schemas/Model1"}},"Model1":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"string","description":"The starting quantity for the tier."},"endingQuantity":{"type":"string","description":"The ending quantity for the tier. Optional for the last tier."},"amount":{"$ref":"#/components/schemas/amount"}}},"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}},"frequency":{"required":["intervalUnit"],"type":"object","properties":{"intervalUnit":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["DAY","WEEK","MONTH","YEAR"]},"intervalCount":{"type":"number","description":"The number of intervals after which a subscriber is billed."}}}}}}
```

## The Model35 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model35":{"minItems":1,"type":"array","description":"An array of billing cycles for trial billing and regular billing","items":{"$ref":"#/components/schemas/Model34"}},"Model34":{"required":["sequence","tenureType"],"type":"object","properties":{"pricingScheme":{"$ref":"#/components/schemas/pricingScheme"},"frequency":{"$ref":"#/components/schemas/frequency"},"tenureType":{"type":"string","description":"The tenure type of the billing cycle.","enum":["REGULAR","TRIAL"]},"sequence":{"type":"number","description":"The order in which this cycle is to run among other billing cycles."},"totalCycles":{"type":"number","description":"The number of times this billing cycle gets executed."}}},"pricingScheme":{"type":"object","properties":{"version":{"maximum":999,"type":"number","description":"The version of the pricing scheme."},"fixedPrice":{"$ref":"#/components/schemas/fixedPrice"},"pricingModel":{"type":"string","description":"The pricing model for tiered plan","enum":["VOLUME","TIERED"]},"tiers":{"$ref":"#/components/schemas/tiers"}},"description":"The active pricing scheme for this billing cycle."},"fixedPrice":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The fixed amount to charge for the subscription"},"tiers":{"type":"array","description":"An array of pricing tiers which are used for billing volume/tiered plans.","items":{"$ref":"#/components/schemas/Model1"}},"Model1":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"string","description":"The starting quantity for the tier."},"endingQuantity":{"type":"string","description":"The ending quantity for the tier. Optional for the last tier."},"amount":{"$ref":"#/components/schemas/amount"}}},"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}},"frequency":{"required":["intervalUnit"],"type":"object","properties":{"intervalUnit":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["DAY","WEEK","MONTH","YEAR"]},"intervalCount":{"type":"number","description":"The number of intervals after which a subscriber is billed."}}}}}}
```

## The Model36 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model36":{"required":["billingCycles","name","paymentProviderContract","productId"],"type":"object","properties":{"paymentProviderContract":{"type":"string","description":"PayPal Payment Provider Contract UUID"},"productId":{"type":"string","description":"PayPal catalog product id"},"name":{"maxLength":127,"type":"string","description":"The plan name"},"status":{"type":"string","description":"The initial state of the plan","enum":["ACTIVE","INACTIVE","CREATED"]},"description":{"maxLength":127,"type":"string","description":"The detailed description of the plan."},"billingCycles":{"$ref":"#/components/schemas/Model35"},"paymentPreferences":{"$ref":"#/components/schemas/paymentPreferences"},"taxes":{"$ref":"#/components/schemas/taxes"},"quantitySupported":{"type":"boolean","description":"Indicates whether you can subscribe to this plan by providing a quantity for the goods or service."}}},"Model35":{"minItems":1,"type":"array","description":"An array of billing cycles for trial billing and regular billing","items":{"$ref":"#/components/schemas/Model34"}},"Model34":{"required":["sequence","tenureType"],"type":"object","properties":{"pricingScheme":{"$ref":"#/components/schemas/pricingScheme"},"frequency":{"$ref":"#/components/schemas/frequency"},"tenureType":{"type":"string","description":"The tenure type of the billing cycle.","enum":["REGULAR","TRIAL"]},"sequence":{"type":"number","description":"The order in which this cycle is to run among other billing cycles."},"totalCycles":{"type":"number","description":"The number of times this billing cycle gets executed."}}},"pricingScheme":{"type":"object","properties":{"version":{"maximum":999,"type":"number","description":"The version of the pricing scheme."},"fixedPrice":{"$ref":"#/components/schemas/fixedPrice"},"pricingModel":{"type":"string","description":"The pricing model for tiered plan","enum":["VOLUME","TIERED"]},"tiers":{"$ref":"#/components/schemas/tiers"}},"description":"The active pricing scheme for this billing cycle."},"fixedPrice":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The fixed amount to charge for the subscription"},"tiers":{"type":"array","description":"An array of pricing tiers which are used for billing volume/tiered plans.","items":{"$ref":"#/components/schemas/Model1"}},"Model1":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"string","description":"The starting quantity for the tier."},"endingQuantity":{"type":"string","description":"The ending quantity for the tier. Optional for the last tier."},"amount":{"$ref":"#/components/schemas/amount"}}},"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}},"frequency":{"required":["intervalUnit"],"type":"object","properties":{"intervalUnit":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["DAY","WEEK","MONTH","YEAR"]},"intervalCount":{"type":"number","description":"The number of intervals after which a subscriber is billed."}}},"paymentPreferences":{"type":"object","properties":{"autoBillOutstanding":{"type":"boolean","description":"Indicates whether to automatically bill the outstanding amount in the next billing cycle."},"setupFee":{"$ref":"#/components/schemas/setupFee"},"setupFeeFailureAction":{"type":"string","description":"The action to take on the subscription if the initial payment for the setup fails.","enum":["CONTINUE","CANCEL"]},"paymentFailureThreshold":{"type":"number","description":"The maximum number of payment failures before a subscription is suspended."}},"description":"The payment preferences for a subscription."},"setupFee":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The initial set-up fee for the service."},"taxes":{"required":["percentage"],"type":"object","properties":{"percentage":{"type":"string","description":"The tax percentage on the billing amount."},"inclusive":{"type":"boolean","description":"Indicates whether the tax was already included in the billing amount."}},"description":"The tax details."}}}}
```

## The Model37 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model37":{"required":["billingCycles","createTime","id","name","productId","status"],"type":"object","properties":{"id":{"maxLength":50,"minLength":6,"type":"string","description":"The unique PayPal-generated ID for the plan."},"productId":{"type":"string","description":"PayPal catalog product id"},"name":{"maxLength":127,"type":"string","description":"The plan name"},"status":{"type":"string","description":"The initial state of the plan","enum":["ACTIVE","INACTIVE","CREATED"]},"description":{"maxLength":127,"type":"string","description":"The detailed description of the plan."},"billingCycles":{"$ref":"#/components/schemas/billingCycles"},"paymentPreferences":{"$ref":"#/components/schemas/paymentPreferences"},"taxes":{"$ref":"#/components/schemas/taxes"},"quantitySupported":{"type":"boolean","description":"Indicates whether you can subscribe to this plan by providing a quantity for the goods or service."},"createTime":{"type":"string","description":"The date and time when the billing plan was created.","format":"date"},"updateTime":{"type":"string","description":"The date and time when the billing plan was updated.","format":"date"}}},"billingCycles":{"minItems":1,"type":"array","description":"An array of billing cycles for trial billing and regular billing","items":{"$ref":"#/components/schemas/Model2"}},"Model2":{"required":["frequency","sequence","tenureType"],"type":"object","properties":{"pricingScheme":{"$ref":"#/components/schemas/pricingScheme"},"frequency":{"$ref":"#/components/schemas/frequency"},"tenureType":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["REGULAR","TRIAL"]},"sequence":{"type":"number","description":"The order in which this cycle is to run among other billing cycles."},"totalCycles":{"type":"number","description":"The number of times this billing cycle gets executed."}}},"pricingScheme":{"type":"object","properties":{"version":{"maximum":999,"type":"number","description":"The version of the pricing scheme."},"fixedPrice":{"$ref":"#/components/schemas/fixedPrice"},"pricingModel":{"type":"string","description":"The pricing model for tiered plan","enum":["VOLUME","TIERED"]},"tiers":{"$ref":"#/components/schemas/tiers"}},"description":"The active pricing scheme for this billing cycle."},"fixedPrice":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The fixed amount to charge for the subscription"},"tiers":{"type":"array","description":"An array of pricing tiers which are used for billing volume/tiered plans.","items":{"$ref":"#/components/schemas/Model1"}},"Model1":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"string","description":"The starting quantity for the tier."},"endingQuantity":{"type":"string","description":"The ending quantity for the tier. Optional for the last tier."},"amount":{"$ref":"#/components/schemas/amount"}}},"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}},"frequency":{"required":["intervalUnit"],"type":"object","properties":{"intervalUnit":{"type":"string","description":"The interval at which the subscription is charged or billed.","enum":["DAY","WEEK","MONTH","YEAR"]},"intervalCount":{"type":"number","description":"The number of intervals after which a subscriber is billed."}}},"paymentPreferences":{"type":"object","properties":{"autoBillOutstanding":{"type":"boolean","description":"Indicates whether to automatically bill the outstanding amount in the next billing cycle."},"setupFee":{"$ref":"#/components/schemas/setupFee"},"setupFeeFailureAction":{"type":"string","description":"The action to take on the subscription if the initial payment for the setup fails.","enum":["CONTINUE","CANCEL"]},"paymentFailureThreshold":{"type":"number","description":"The maximum number of payment failures before a subscription is suspended."}},"description":"The payment preferences for a subscription."},"setupFee":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The initial set-up fee for the service."},"taxes":{"required":["percentage"],"type":"object","properties":{"percentage":{"type":"string","description":"The tax percentage on the billing amount."},"inclusive":{"type":"boolean","description":"Indicates whether the tax was already included in the billing amount."}},"description":"The tax details."}}}}
```

## The Model38 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model38":{"required":["paymentProviderContract"],"type":"object","properties":{"paymentProviderContract":{"type":"string","description":"PayPal Payment Provider Contract UUID"}}}}}}
```

## The Model39 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model39":{"required":["paymentProviderContract"],"type":"object","properties":{"paymentProviderContract":{"type":"string","description":"PayPal Payment Provider Contract UUID"},"planId":{"maxLength":50,"minLength":3,"type":"string","description":"The ID of the plan"},"effectiveTime":{"type":"string","description":"The date and time when this change is effective","format":"date"},"quantity":{"type":"integer","description":"The quantity of the product or service in the subscription"},"shippingAmount":{"$ref":"#/components/schemas/Model19"},"shippingAddress":{"$ref":"#/components/schemas/Model12"},"applicationContext":{"$ref":"#/components/schemas/applicationContext"}}},"Model19":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Shipping charges amount"},"Model12":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Model11"},"address":{"$ref":"#/components/schemas/billingAddress"}},"description":"The shipping details"},"Model11":{"type":"object","properties":{"fullName":{"maxLength":300,"type":"string"}},"description":"The name of the person to whom to ship the items"},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"},"applicationContext":{"type":"object","properties":{"brandName":{"type":"string","description":"The label that overrides the business name in the PayPal account on the PayPal site"},"locale":{"type":"string","description":"The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW"},"shippingPreference":{"type":"string","description":"The location from which the shipping address is derived","enum":["GET_FROM_FILE","NO_SHIPPING","SET_PROVIDED_ADDRESS"]},"userAction":{"type":"string","description":"Configures the label name to Continue or Subscribe Now for subscription consent experience","enum":["CONTINUE","SUBSCRIBE_NOW"]},"paymentMethod":{"$ref":"#/components/schemas/paymentMethod"},"returnUrl":{"type":"string","description":"The URL where the customer is redirected after the customer approves the payment"},"cancelUrl":{"type":"string","description":"The URL where the customer is redirected after the customer cancels the payment"}},"description":"The application context, which customizes the payer experience during the subscription approval process with PayPal"},"paymentMethod":{"type":"object","properties":{"payerSelected":{"type":"string","description":"The customer-selected payment method on the merchant site"},"payeePreferred":{"type":"string","description":"The merchant-preferred payment methods","enum":["UNRESTRICTED","IMMEDIATE_PAYMENT_REQUIRED"]}},"description":"The customer and merchant payment preferences. Currently only PAYPAL payment method is supported"}}}}
```

## The Model40 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model40":{"required":["paymentProviderContract"],"type":"object","properties":{"paymentProviderContract":{"type":"string","description":"PayPal Payment Provider Contract UUID"},"reason":{"type":"string","description":"The reason for the cancellation of a subscription."},"amount":{"description":"The amount of the outstanding balance. This value cannot be greater than the current outstanding balance amount.","required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}}}}}}}}
```

## The Model41 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model41":{"required":["amount","paymentProviderContract","reason"],"type":"object","properties":{"paymentProviderContract":{"type":"string","description":"PayPal Payment Provider Contract UUID"},"reason":{"type":"string","description":"The reason or note for the subscription charge."},"amount":{"$ref":"#/components/schemas/amount"}}},"amount":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}}}}}}
```

## The Model42 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model42":{"required":["paymentProviderContract"],"type":"object","properties":{"reason":{"type":"string","description":"The reason for activation of a subscription"},"paymentProviderContract":{"type":"string","description":"PayPal Payment Provider Contract UUID"}}}}}}
```

## The Model43 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model43":{"required":["paymentProviderContract"],"type":"object","properties":{"paymentProviderContract":{"type":"string","description":"PayPal Payment Provider Contract UUID"},"reason":{"type":"string","description":"The reason for suspenson of the subscription."}}}}}}
```

## The Model44 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model44":{"required":["paymentProviderContract"],"type":"object","properties":{"paymentProviderContract":{"type":"string","description":"Payment Provider contract"},"trackingId":{"type":"string","description":"A unique ID to track each transaction"},"data":{"$ref":"#/components/schemas/details"}}},"details":{"type":"object"}}}}
```

## The Model45 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model45":{"required":["trackingId"],"type":"object","properties":{"trackingId":{"type":"string","description":"A unique ID to track each transaction"}}}}}}
```

## The Model46 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model46":{"type":"object","properties":{"agreementId":{"type":"string","description":"PayPal billing agreement id"},"merchantReference":{"maxLength":127,"type":"string","description":"The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer."}}}}}}
```

## The Model47 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model47":{"required":["authorizationId","createdAt","id","instoreReference"],"type":"object","properties":{"id":{"type":"string","description":"Transaction UUID from create transaction API"},"authorizationId":{"type":"string","description":"PayPal authorization identifier"},"createdAt":{"type":"string","description":"Authorization creation date (ISO-8601)","format":"date"},"expiresAt":{"type":"string","description":"Authorization expiration date (ISO-8601)","format":"date"},"status":{"type":"string","description":"Transaction status","enum":["AUTHORISED"]},"payer":{"$ref":"#/components/schemas/Auth_Payer_Info"},"instoreReference":{"type":"string","description":"Reference to the transaction for internal usage for instore"}}},"Auth_Payer_Info":{"type":"object","properties":{"payerId":{"type":"string","description":"The PayPal-assigned ID for the payer","pattern":"^[2-9A-HJ-NP-Z]{13}$"},"name":{"$ref":"#/components/schemas/Payer_Name"},"phoneNumber":{"$ref":"#/components/schemas/Phone_number"},"email":{"type":"string","description":"The email address of the payer.","maxLength":255},"shippingAddress":{"$ref":"#/components/schemas/Shipping-Address"},"authorizationStatus":{"type":"string","description":"The status of the authorized payment.\n\nThe possible values are:\n\n* CREATED. The authorized payment is created. No captured payments have been made for this authorized payment.\n* PARTIALLY_CREATED. The payment which was authorized for an amount that is less than the originally requested amount.\n* DENIED. PayPal cannot authorize funds for this authorized payment.\n* PENDING. The created authorization is in pending state. A manual review might be pending."}}},"Payer_Name":{"type":"object","description":"The name of the payer.","properties":{"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"}}},"Phone_number":{"required":["value"],"type":"object","properties":{"phoneType":{"type":"string","description":"Customer phone type","enum":["FAX","HOME","MOBILE","OTHER","PAGER"]},"value":{"type":"string","description":"Customer phone number"}},"description":"Phone number"},"Shipping-Address":{"type":"object","description":"Shipping Address details","properties":{"country":{"type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region.","minLength":2,"maxLength":2,"pattern":"^([A-Z]{2}|C2)$"},"postalCode":{"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent.","maxLength":60},"countrySubdivision":{"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.","maxLength":300},"city":{"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1","maxLength":120},"addressLine2":{"type":"string","description":"The second line of the address. For example, suite or apartment number.","maxLength":300},"addressLine1":{"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.","maxLength":300},"fullName":{"type":"string","description":"The name of the person to whom to ship the items."}},"required":["country","postalCode"]}}}}
```

## The Auth\_Payer\_Info object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Auth_Payer_Info":{"type":"object","properties":{"payerId":{"type":"string","description":"The PayPal-assigned ID for the payer","pattern":"^[2-9A-HJ-NP-Z]{13}$"},"name":{"$ref":"#/components/schemas/Payer_Name"},"phoneNumber":{"$ref":"#/components/schemas/Phone_number"},"email":{"type":"string","description":"The email address of the payer.","maxLength":255},"shippingAddress":{"$ref":"#/components/schemas/Shipping-Address"},"authorizationStatus":{"type":"string","description":"The status of the authorized payment.\n\nThe possible values are:\n\n* CREATED. The authorized payment is created. No captured payments have been made for this authorized payment.\n* PARTIALLY_CREATED. The payment which was authorized for an amount that is less than the originally requested amount.\n* DENIED. PayPal cannot authorize funds for this authorized payment.\n* PENDING. The created authorization is in pending state. A manual review might be pending."}}},"Payer_Name":{"type":"object","description":"The name of the payer.","properties":{"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"}}},"Phone_number":{"required":["value"],"type":"object","properties":{"phoneType":{"type":"string","description":"Customer phone type","enum":["FAX","HOME","MOBILE","OTHER","PAGER"]},"value":{"type":"string","description":"Customer phone number"}},"description":"Phone number"},"Shipping-Address":{"type":"object","description":"Shipping Address details","properties":{"country":{"type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region.","minLength":2,"maxLength":2,"pattern":"^([A-Z]{2}|C2)$"},"postalCode":{"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent.","maxLength":60},"countrySubdivision":{"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.","maxLength":300},"city":{"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1","maxLength":120},"addressLine2":{"type":"string","description":"The second line of the address. For example, suite or apartment number.","maxLength":300},"addressLine1":{"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.","maxLength":300},"fullName":{"type":"string","description":"The name of the person to whom to ship the items."}},"required":["country","postalCode"]}}}}
```

## The Model48 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model48":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Amount to capture. If not provided, full capture will be performed."}}}}
```

## The Model49 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model49":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Model48"},"description":{"maxLength":127,"type":"string","description":"An informational note about the capture. Appears in both the payer's transaction history and the\n emails that the payer receives."},"agreementId":{"type":"string","description":"Billing Agreement id"},"merchantReference":{"maxLength":127,"type":"string","description":"The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer."}}},"Model48":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Amount to capture. If not provided, full capture will be performed."}}}}
```

## The Capture\_Payer\_Info object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Capture_Payer_Info":{"type":"object","properties":{"payerId":{"type":"string","description":"The PayPal-assigned ID for the payer","pattern":"^[2-9A-HJ-NP-Z]{13}$"},"name":{"$ref":"#/components/schemas/Payer_Name"},"phoneNumber":{"$ref":"#/components/schemas/Phone_number"},"email":{"type":"string","description":"The email address of the payer.","maxLength":255},"shippingAddress":{"$ref":"#/components/schemas/Shipping-Address"},"paymentStatus":{"type":"string","description":"The status of the captured payment.\n\nThe possible values are:\n\n* COMPLETED. The funds for this captured payment were credited to the payee's PayPal account.\n* DECLINED. The funds could not be captured.\n* PENDING. The funds for this captured payment was not yet credited to the payee's PayPal account. A manual review might be pending.\n* FAILED. There was an error while capturing payment."}}},"Payer_Name":{"type":"object","description":"The name of the payer.","properties":{"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"}}},"Phone_number":{"required":["value"],"type":"object","properties":{"phoneType":{"type":"string","description":"Customer phone type","enum":["FAX","HOME","MOBILE","OTHER","PAGER"]},"value":{"type":"string","description":"Customer phone number"}},"description":"Phone number"},"Shipping-Address":{"type":"object","description":"Shipping Address details","properties":{"country":{"type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region.","minLength":2,"maxLength":2,"pattern":"^([A-Z]{2}|C2)$"},"postalCode":{"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent.","maxLength":60},"countrySubdivision":{"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.","maxLength":300},"city":{"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1","maxLength":120},"addressLine2":{"type":"string","description":"The second line of the address. For example, suite or apartment number.","maxLength":300},"addressLine1":{"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.","maxLength":300},"fullName":{"type":"string","description":"The name of the person to whom to ship the items."}},"required":["country","postalCode"]}}}}
```

## The Model50 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model50":{"required":["captureId","createdAt","id","instoreReference"],"type":"object","properties":{"id":{"type":"string","description":"Transaction UUID from create transaction API"},"captureId":{"type":"string","description":"PayPal capture identifier"},"isFinalCapture":{"type":"boolean","description":"Flag telling if capture is final or not"},"instoreReference":{"type":"string","description":"Reference to the transaction for internal usage for instore"},"createdAt":{"type":"string","description":"Capture creation date (ISO-8601)","format":"date"},"status":{"type":"string","description":"Transaction status","enum":["AUTHORISED"]},"payer":{"$ref":"#/components/schemas/Capture_Payer_Info"}}},"Capture_Payer_Info":{"type":"object","properties":{"payerId":{"type":"string","description":"The PayPal-assigned ID for the payer","pattern":"^[2-9A-HJ-NP-Z]{13}$"},"name":{"$ref":"#/components/schemas/Payer_Name"},"phoneNumber":{"$ref":"#/components/schemas/Phone_number"},"email":{"type":"string","description":"The email address of the payer.","maxLength":255},"shippingAddress":{"$ref":"#/components/schemas/Shipping-Address"},"paymentStatus":{"type":"string","description":"The status of the captured payment.\n\nThe possible values are:\n\n* COMPLETED. The funds for this captured payment were credited to the payee's PayPal account.\n* DECLINED. The funds could not be captured.\n* PENDING. The funds for this captured payment was not yet credited to the payee's PayPal account. A manual review might be pending.\n* FAILED. There was an error while capturing payment."}}},"Payer_Name":{"type":"object","description":"The name of the payer.","properties":{"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"}}},"Phone_number":{"required":["value"],"type":"object","properties":{"phoneType":{"type":"string","description":"Customer phone type","enum":["FAX","HOME","MOBILE","OTHER","PAGER"]},"value":{"type":"string","description":"Customer phone number"}},"description":"Phone number"},"Shipping-Address":{"type":"object","description":"Shipping Address details","properties":{"country":{"type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region.","minLength":2,"maxLength":2,"pattern":"^([A-Z]{2}|C2)$"},"postalCode":{"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent.","maxLength":60},"countrySubdivision":{"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.","maxLength":300},"city":{"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1","maxLength":120},"addressLine2":{"type":"string","description":"The second line of the address. For example, suite or apartment number.","maxLength":300},"addressLine1":{"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.","maxLength":300},"fullName":{"type":"string","description":"The name of the person to whom to ship the items."}},"required":["country","postalCode"]}}}}
```

## The Model51 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model51":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Amount to refund. If not provided, full refund will be performed."}}}}
```

## The Model52 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model52":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Model51"},"reason":{"maxLength":127,"type":"string","description":"The reason for the refund. Appears in both the payer's transaction history and the emails that the\n payer receives."},"merchantReference":{"maxLength":127,"type":"string","description":"The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer."}}},"Model51":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Amount to refund. If not provided, full refund will be performed."}}}}
```

## The Model53 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model53":{"required":["createdAt","id","instoreReference","refundId"],"type":"object","properties":{"id":{"type":"string","description":"Transaction UUID from create transaction API"},"refundId":{"type":"string","description":"Refund identifier"},"createdAt":{"type":"string","description":"Refund creation date (ISO-8601)","format":"date"},"status":{"type":"string","description":"Transaction status","enum":["AUTHORISED"]},"instoreReference":{"type":"string","description":"Reference to the transaction for internal usage for instore"}}}}}}
```

## The imageUrl object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"imageUrl":{"required":["op"],"type":"object","properties":{"op":{"type":"string","description":"The remove operation does not require a value","enum":["add","remove","replace"]},"value":{"maxLength":2000,"minLength":1,"type":"string","description":"The home page URL for the product"}}}}}}
```

## The homeUrl object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"homeUrl":{"required":["op"],"type":"object","properties":{"op":{"type":"string","description":"The remove operation does not require a value","enum":["add","remove","replace"]},"value":{"maxLength":2000,"minLength":1,"type":"string","description":"The image URL for the product"}}}}}}
```

## The category object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"category":{"required":["op"],"type":"object","properties":{"op":{"type":"string","description":"The remove operation does not require a value","enum":["add","remove","replace"]},"value":{"type":"string","description":"The product category","enum":["AC_REFRIGERATION_REPAIR","ACADEMIC_SOFTWARE","ACCESSORIES","ACCOUNTING","ADULT","ADVERTISING","AFFILIATED_AUTO_RENTAL","AGENCIES","AGGREGATORS","AGRICULTURAL_COOPERATIVE_FOR_MAIL_ORDER","AIR_CARRIERS_AIRLINES","AIRLINES","AIRPORTS_FLYING_FIELDS","ALCOHOLIC_BEVERAGES","AMUSEMENT_PARKS_CARNIVALS","ANIMATION","ANTIQUES","APPLIANCES","AQUARIAMS_SEAQUARIUMS_DOLPHINARIUMS","ARCHITECTURAL_ENGINEERING_AND_SURVEYING_SERVICES","ART_AND_CRAFT_SUPPLIES","ART_DEALERS_AND_GALLERIES","ARTIFACTS_GRAVE_RELATED_AND_NATIVE_AMERICAN_CRAFTS","ARTS_AND_CRAFTS","ARTS_CRAFTS_AND_COLLECTIBLES","AUDIO_BOOKS","AUTO_ASSOCIATIONS_CLUBS","AUTO_DEALER_USED_ONLY","AUTO_RENTALS","AUTO_SERVICE","AUTOMATED_FUEL_DISPENSERS","AUTOMOBILE_ASSOCIATIONS","AUTOMOTIVE","AUTOMOTIVE_REPAIR_SHOPS_NON_DEALER","AUTOMOTIVE_TOP_AND_BODY_SHOPS","AVIATION","BABIES_CLOTHING_AND_SUPPLIES","BABY","BANDS_ORCHESTRAS_ENTERTAINERS","BARBIES","BATH_AND_BODY","BATTERIES","BEAN_BABIES","BEAUTY","BEAUTY_AND_FRAGRANCES","BED_AND_BATH","BICYCLE_SHOPS_SALES_AND_SERVICE","BICYCLES_AND_ACCESSORIES","BILLIARD_POOL_ESTABLISHMENTS","BOAT_DEALERS","BOAT_RENTALS_AND_LEASING","BOATING_SAILING_AND_ACCESSORIES","BOOKS","BOOKS_AND_MAGAZINES","BOOKS_MANUSCRIPTS","BOOKS_PERIODICALS_AND_NEWSPAPERS","BOWLING_ALLEYS","BULLETIN_BOARD","BUS_LINE","BUS_LINES_CHARTERS_TOUR_BUSES","BUSINESS","BUSINESS_AND_SECRETARIAL_SCHOOLS","BUYING_AND_SHOPPING_SERVICES_AND_CLUBS","CABLE_SATELLITE_AND_OTHER_PAY_TELEVISION_AND_RADIO_SERVICES","CABLE_SATELLITE_AND_OTHER_PAY_TV_AND_RADIO","CAMERA_AND_PHOTOGRAPHIC_SUPPLIES","CAMERAS","CAMERAS_AND_PHOTOGRAPHY","CAMPER_RECREATIONAL_AND_UTILITY_TRAILER_DEALERS","CAMPING_AND_OUTDOORS","CAMPING_AND_SURVIVAL","CAR_AND_TRUCK_DEALERS","CAR_AND_TRUCK_DEALERS_USED_ONLY","CAR_AUDIO_AND_ELECTRONICS","CAR_RENTAL_AGENCY","CATALOG_MERCHANT","CATALOG_RETAIL_MERCHANT","CATERING_SERVICES","CHARITY","CHECK_CASHIER","CHILD_CARE_SERVICES","CHILDREN_BOOKS","CHIROPODISTS_PODIATRISTS","CHIROPRACTORS","CIGAR_STORES_AND_STANDS","CIVIC_SOCIAL_FRATERNAL_ASSOCIATIONS","CIVIL_SOCIAL_FRAT_ASSOCIATIONS","CLOTHING","CLOTHING_ACCESSORIES_AND_SHOES","CLOTHING_RENTAL","COFFEE_AND_TEA","COIN_OPERATED_BANKS_AND_CASINOS","COLLECTIBLES","COLLECTION_AGENCY","COLLEGES_AND_UNIVERSITIES","COMMERCIAL_EQUIPMENT","COMMERCIAL_FOOTWEAR","COMMERCIAL_PHOTOGRAPHY","COMMERCIAL_PHOTOGRAPHY_ART_AND_GRAPHICS","COMMERCIAL_SPORTS_PROFESSIONA","COMMODITIES_AND_FUTURES_EXCHANGE","COMPUTER_AND_DATA_PROCESSING_SERVICES","COMPUTER_HARDWARE_AND_SOFTWARE","COMPUTER_MAINTENANCE_REPAIR_AND_SERVICES_NOT_ELSEWHERE_CLAS","CONSTRUCTION","CONSTRUCTION_MATERIALS_NOT_ELSEWHERE_CLASSIFIED","CONSULTING_SERVICES","CONSUMER_CREDIT_REPORTING_AGENCIES","CONVALESCENT_HOMES","COSMETIC_STORES","COUNSELING_SERVICES_DEBT_MARRIAGE_PERSONAL","COUNTERFEIT_CURRENCY_AND_STAMPS","COUNTERFEIT_ITEMS","COUNTRY_CLUBS","COURIER_SERVICES","COURIER_SERVICES_AIR_AND_GROUND_AND_FREIGHT_FORWARDERS","COURT_COSTS_ALIMNY_CHILD_SUPT","COURT_COSTS_INCLUDING_ALIMONY_AND_CHILD_SUPPORT_COURTS_OF_LAW","CREDIT_CARDS","CREDIT_UNION","CULTURE_AND_RELIGION","DAIRY_PRODUCTS_STORES","DANCE_HALLS_STUDIOS_AND_SCHOOLS","DECORATIVE","DENTAL","DENTISTS_AND_ORTHODONTISTS","DEPARTMENT_STORES","DESKTOP_PCS","DEVICES","DIECAST_TOYS_VEHICLES","DIGITAL_GAMES","DIGITAL_MEDIA_BOOKS_MOVIES_MUSIC","DIRECT_MARKETING","DIRECT_MARKETING_CATALOG_MERCHANT","DIRECT_MARKETING_INBOUND_TELE","DIRECT_MARKETING_OUTBOUND_TELE","DIRECT_MARKETING_SUBSCRIPTION","DISCOUNT_STORES","DOOR_TO_DOOR_SALES","DRAPERY_WINDOW_COVERING_AND_UPHOLSTERY","DRINKING_PLACES","DRUGSTORE","DURABLE_GOODS","ECOMMERCE_DEVELOPMENT","ECOMMERCE_SERVICES","EDUCATIONAL_AND_TEXTBOOKS","ELECTRIC_RAZOR_STORES","ELECTRICAL_AND_SMALL_APPLIANCE_REPAIR","ELECTRICAL_CONTRACTORS","ELECTRICAL_PARTS_AND_EQUIPMENT","ELECTRONIC_CASH","ELEMENTARY_AND_SECONDARY_SCHOOLS","EMPLOYMENT","ENTERTAINERS","ENTERTAINMENT_AND_MEDIA","EQUIP_TOOL_FURNITURE_AND_APPLIANCE_RENTAL_AND_LEASING","ESCROW","EVENT_AND_WEDDING_PLANNING","EXERCISE_AND_FITNESS","EXERCISE_EQUIPMENT","EXTERMINATING_AND_DISINFECTING_SERVICES","FABRICS_AND_SEWING","FAMILY_CLOTHING_STORES","FASHION_JEWELRY","FAST_FOOD_RESTAURANTS","FICTION_AND_NONFICTION","FINANCE_COMPANY","FINANCIAL_AND_INVESTMENT_ADVICE","FINANCIAL_INSTITUTIONS_MERCHANDISE_AND_SERVICES","FIREARM_ACCESSORIES","FIREARMS_WEAPONS_AND_KNIVES","FIREPLACE_AND_FIREPLACE_SCREENS","FIREWORKS","FISHING","FLORISTS","FLOWERS","FOOD_DRINK_AND_NUTRITION","FOOD_PRODUCTS","FOOD_RETAIL_AND_SERVICE","FRAGRANCES_AND_PERFUMES","FREEZER_AND_LOCKER_MEAT_PROVISIONERS","FUEL_DEALERS_FUEL_OIL_WOOD_AND_COAL","FUEL_DEALERS_NON_AUTOMOTIVE","FUNERAL_SERVICES_AND_CREMATORIES","FURNISHING_AND_DECORATING","FURNITURE","FURRIERS_AND_FUR_SHOPS","GADGETS_AND_OTHER_ELECTRONICS","GAMBLING","GAME_SOFTWARE","GAMES","GARDEN_SUPPLIES","GENERAL","GENERAL_CONTRACTORS","GENERAL_GOVERNMENT","GENERAL_SOFTWARE","GENERAL_TELECOM","GIFTS_AND_FLOWERS","GLASS_PAINT_AND_WALLPAPER_STORES","GLASSWARE_CRYSTAL_STORES","GOVERNMENT","GOVERNMENT_IDS_AND_LICENSES","GOVERNMENT_LICENSED_ON_LINE_CASINOS_ON_LINE_GAMBLING","GOVERNMENT_OWNED_LOTTERIES","GOVERNMENT_SERVICES","GRAPHIC_AND_COMMERCIAL_DESIGN","GREETING_CARDS","GROCERY_STORES_AND_SUPERMARKETS","HARDWARE_AND_TOOLS","HARDWARE_EQUIPMENT_AND_SUPPLIES","HAZARDOUS_RESTRICTED_AND_PERISHABLE_ITEMS","HEALTH_AND_BEAUTY_SPAS","HEALTH_AND_NUTRITION","HEALTH_AND_PERSONAL_CARE","HEARING_AIDS_SALES_AND_SUPPLIES","HEATING_PLUMBING_AC","HIGH_RISK_MERCHANT","HIRING_SERVICES","HOBBIES_TOYS_AND_GAMES","HOME_AND_GARDEN","HOME_AUDIO","HOME_DECOR","HOME_ELECTRONICS","HOSPITALS","HOTELS_MOTELS_INNS_RESORTS","HOUSEWARES","HUMAN_PARTS_AND_REMAINS","HUMOROUS_GIFTS_AND_NOVELTIES","HUNTING","IDS_LICENSES_AND_PASSPORTS","ILLEGAL_DRUGS_AND_PARAPHERNALIA","INDUSTRIAL","INDUSTRIAL_AND_MANUFACTURING_SUPPLIES","INSURANCE_AUTO_AND_HOME","INSURANCE_DIRECT","INSURANCE_LIFE_AND_ANNUITY","INSURANCE_SALES_UNDERWRITING","INSURANCE_UNDERWRITING_PREMIUMS","INTERNET_AND_NETWORK_SERVICES","INTRA_COMPANY_PURCHASES","LABORATORIES_DENTAL_MEDICAL","LANDSCAPING","LANDSCAPING_AND_HORTICULTURAL_SERVICES","LAUNDRY_CLEANING_SERVICES","LEGAL","LEGAL_SERVICES_AND_ATTORNEYS","LOCAL_DELIVERY_SERVICE","LOCKSMITH","LODGING_AND_ACCOMMODATIONS","LOTTERY_AND_CONTESTS","LUGGAGE_AND_LEATHER_GOODS","LUMBER_AND_BUILDING_MATERIALS","MAGAZINES","MAINTENANCE_AND_REPAIR_SERVICES","MAKEUP_AND_COSMETICS","MANUAL_CASH_DISBURSEMENTS","MASSAGE_PARLORS","MEDICAL","MEDICAL_AND_PHARMACEUTICAL","MEDICAL_CARE","MEDICAL_EQUIPMENT_AND_SUPPLIES","MEDICAL_SERVICES","MEETING_PLANNERS","MEMBERSHIP_CLUBS_AND_ORGANIZATIONS","MEMBERSHIP_COUNTRY_CLUBS_GOLF","MEMORABILIA","MEN_AND_BOY_CLOTHING_AND_ACCESSORY_STORES","MEN_CLOTHING","MERCHANDISE","METAPHYSICAL","MILITARIA","MILITARY_AND_CIVIL_SERVICE_UNIFORMS","MISC","MISCELLANEOUS_GENERAL_SERVICES","MISCELLANEOUS_REPAIR_SHOPS_AND_RELATED_SERVICES","MODEL_KITS","MONEY_TRANSFER_MEMBER_FINANCIAL_INSTITUTION","MONEY_TRANSFER_MERCHANT","MOTION_PICTURE_THEATERS","MOTOR_FREIGHT_CARRIERS_AND_TRUCKING","MOTOR_HOME_AND_RECREATIONAL_VEHICLE_RENTAL","MOTOR_HOMES_DEALERS","MOTOR_VEHICLE_SUPPLIES_AND_NEW_PARTS","MOTORCYCLE_DEALERS","MOTORCYCLES","MOVIE","MOVIE_TICKETS","MOVING_AND_STORAGE","MULTI_LEVEL_MARKETING","MUSIC_CDS_CASSETTES_AND_ALBUMS","MUSIC_STORE_INSTRUMENTS_AND_SHEET_MUSIC","NETWORKING","NEW_AGE","NEW_PARTS_AND_SUPPLIES_MOTOR_VEHICLE","NEWS_DEALERS_AND_NEWSTANDS","NON_DURABLE_GOODS","NON_FICTION","NON_PROFIT_POLITICAL_AND_RELIGION","NONPROFIT","NOVELTIES","OEM_SOFTWARE","OFFICE_SUPPLIES_AND_EQUIPMENT","ONLINE_DATING","ONLINE_GAMING","ONLINE_GAMING_CURRENCY","ONLINE_SERVICES","OOUTBOUND_TELEMARKETING_MERCH","OPHTHALMOLOGISTS_OPTOMETRIST","OPTICIANS_AND_DISPENSING","ORTHOPEDIC_GOODS_PROSTHETICS","OSTEOPATHS","OTHER","PACKAGE_TOUR_OPERATORS","PAINTBALL","PAINTS_VARNISHES_AND_SUPPLIES","PARKING_LOTS_AND_GARAGES","PARTS_AND_ACCESSORIES","PAWN_SHOPS","PAYCHECK_LENDER_OR_CASH_ADVANCE","PERIPHERALS","PERSONALIZED_GIFTS","PET_SHOPS_PET_FOOD_AND_SUPPLIES","PETROLEUM_AND_PETROLEUM_PRODUCTS","PETS_AND_ANIMALS","PHOTOFINISHING_LABORATORIES_PHOTO_DEVELOPING","PHOTOGRAPHIC_STUDIOS_PORTRAITS","PHOTOGRAPHY","PHYSICAL_GOOD","PICTURE_VIDEO_PRODUCTION","PIECE_GOODS_NOTIONS_AND_OTHER_DRY_GOODS","PLANTS_AND_SEEDS","PLUMBING_AND_HEATING_EQUIPMENTS_AND_SUPPLIES","POLICE_RELATED_ITEMS","POLITICAL_ORGANIZATIONS","POSTAL_SERVICES_GOVERNMENT_ONLY","POSTERS","PREPAID_AND_STORED_VALUE_CARDS","PRESCRIPTION_DRUGS","PROMOTIONAL_ITEMS","PUBLIC_WAREHOUSING_AND_STORAGE","PUBLISHING_AND_PRINTING","PUBLISHING_SERVICES","RADAR_DECTORS","RADIO_TELEVISION_AND_STEREO_REPAIR","REAL_ESTATE","REAL_ESTATE_AGENT","REAL_ESTATE_AGENTS_AND_MANAGERS_RENTALS","RELIGION_AND_SPIRITUALITY_FOR_PROFIT","RELIGIOUS","RELIGIOUS_ORGANIZATIONS","REMITTANCE","RENTAL_PROPERTY_MANAGEMENT","RESIDENTIAL","RETAIL","RETAIL_FINE_JEWELRY_AND_WATCHES","REUPHOLSTERY_AND_FURNITURE_REPAIR","RINGS","ROOFING_SIDING_SHEET_METAL","RUGS_AND_CARPETS","SCHOOLS_AND_COLLEGES","SCIENCE_FICTION","SCRAPBOOKING","SCULPTURES","SECURITIES_BROKERS_AND_DEALERS","SECURITY_AND_SURVEILLANCE","SECURITY_AND_SURVEILLANCE_EQUIPMENT","SECURITY_BROKERS_AND_DEALERS","SEMINARS","SERVICE_STATIONS","SERVICES","SEWING_NEEDLEWORK_FABRIC_AND_PIECE_GOODS_STORES","SHIPPING_AND_PACKING","SHOE_REPAIR_HAT_CLEANING","SHOE_STORES","SHOES","SNOWMOBILE_DEALERS","SOFTWARE","SPECIALTY_AND_MISC","SPECIALTY_CLEANING_POLISHING_AND_SANITATION_PREPARATIONS","SPECIALTY_OR_RARE_PETS","SPORT_GAMES_AND_TOYS","SPORTING_AND_RECREATIONAL_CAMPS","SPORTING_GOODS","SPORTS_AND_OUTDOORS","SPORTS_AND_RECREATION","STAMP_AND_COIN","STATIONARY_PRINTING_AND_WRITING_PAPER","STENOGRAPHIC_AND_SECRETARIAL_SUPPORT_SERVICES","STOCKS_BONDS_SECURITIES_AND_RELATED_CERTIFICATES","STORED_VALUE_CARDS","SUPPLIES","SUPPLIES_AND_TOYS","SURVEILLANCE_EQUIPMENT","SWIMMING_POOLS_AND_SPAS","SWIMMING_POOLS_SALES_SUPPLIES_SERVICES","TAILORS_AND_ALTERATIONS","TAX_PAYMENTS","TAX_PAYMENTS_GOVERNMENT_AGENCIES","TAXICABS_AND_LIMOUSINES","TELECOMMUNICATION_SERVICES","TELEPHONE_CARDS","TELEPHONE_EQUIPMENT","TELEPHONE_SERVICES","THEATER","TIRE_RETREADING_AND_REPAIR","TOLL_OR_BRIDGE_FEES","TOOLS_AND_EQUIPMENT","TOURIST_ATTRACTIONS_AND_EXHIBITS","TOWING_SERVICE","TOYS_AND_GAMES","TRADE_AND_VOCATIONAL_SCHOOLS","TRADEMARK_INFRINGEMENT","TRAILER_PARKS_AND_CAMPGROUNDS","TRAINING_SERVICES","TRANSPORTATION_SERVICES","TRAVEL","TRUCK_AND_UTILITY_TRAILER_RENTALS","TRUCK_STOP","TYPESETTING_PLATE_MAKING_AND_RELATED_SERVICES","USED_MERCHANDISE_AND_SECONDHAND_STORES","USED_PARTS_MOTOR_VEHICLE","UTILITIES","UTILITIES_ELECTRIC_GAS_WATER_SANITARY","VARIETY_STORES","VEHICLE_SALES","VEHICLE_SERVICE_AND_ACCESSORIES","VIDEO_EQUIPMENT","VIDEO_GAME_ARCADES_ESTABLISH","VIDEO_GAMES_AND_SYSTEMS","VIDEO_TAPE_RENTAL_STORES","VINTAGE_AND_COLLECTIBLE_VEHICLES","VINTAGE_AND_COLLECTIBLES","VITAMINS_AND_SUPPLEMENTS","VOCATIONAL_AND_TRADE_SCHOOLS","WATCH_CLOCK_AND_JEWELRY_REPAIR","WEB_HOSTING_AND_DESIGN","WELDING_REPAIR","WHOLESALE_CLUBS","WHOLESALE_FLORIST_SUPPLIERS","WHOLESALE_PRESCRIPTION_DRUGS","WILDLIFE_PRODUCTS","WIRE_TRANSFER","WIRE_TRANSFER_AND_MONEY_ORDER","WOMEN_ACCESSORY_SPECIALITY","WOMEN_CLOTHING"]}}}}}}
```

## The description object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"description":{"required":["op"],"type":"object","properties":{"op":{"type":"string","description":"The remove operation does not require a value","enum":["add","remove","replace"]},"value":{"maxLength":256,"minLength":1,"type":"string","description":"The product description"}}}}}}
```

## The Model54 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model54":{"required":["paymentProviderContract"],"type":"object","properties":{"paymentProviderContract":{"type":"string","description":"PayPal Payment Provider Contract UUID"},"imageUrl":{"$ref":"#/components/schemas/imageUrl"},"homeUrl":{"$ref":"#/components/schemas/homeUrl"},"category":{"$ref":"#/components/schemas/category"},"description":{"$ref":"#/components/schemas/description"}}},"imageUrl":{"required":["op"],"type":"object","properties":{"op":{"type":"string","description":"The remove operation does not require a value","enum":["add","remove","replace"]},"value":{"maxLength":2000,"minLength":1,"type":"string","description":"The home page URL for the product"}}},"homeUrl":{"required":["op"],"type":"object","properties":{"op":{"type":"string","description":"The remove operation does not require a value","enum":["add","remove","replace"]},"value":{"maxLength":2000,"minLength":1,"type":"string","description":"The image URL for the product"}}},"category":{"required":["op"],"type":"object","properties":{"op":{"type":"string","description":"The remove operation does not require a value","enum":["add","remove","replace"]},"value":{"type":"string","description":"The product category","enum":["AC_REFRIGERATION_REPAIR","ACADEMIC_SOFTWARE","ACCESSORIES","ACCOUNTING","ADULT","ADVERTISING","AFFILIATED_AUTO_RENTAL","AGENCIES","AGGREGATORS","AGRICULTURAL_COOPERATIVE_FOR_MAIL_ORDER","AIR_CARRIERS_AIRLINES","AIRLINES","AIRPORTS_FLYING_FIELDS","ALCOHOLIC_BEVERAGES","AMUSEMENT_PARKS_CARNIVALS","ANIMATION","ANTIQUES","APPLIANCES","AQUARIAMS_SEAQUARIUMS_DOLPHINARIUMS","ARCHITECTURAL_ENGINEERING_AND_SURVEYING_SERVICES","ART_AND_CRAFT_SUPPLIES","ART_DEALERS_AND_GALLERIES","ARTIFACTS_GRAVE_RELATED_AND_NATIVE_AMERICAN_CRAFTS","ARTS_AND_CRAFTS","ARTS_CRAFTS_AND_COLLECTIBLES","AUDIO_BOOKS","AUTO_ASSOCIATIONS_CLUBS","AUTO_DEALER_USED_ONLY","AUTO_RENTALS","AUTO_SERVICE","AUTOMATED_FUEL_DISPENSERS","AUTOMOBILE_ASSOCIATIONS","AUTOMOTIVE","AUTOMOTIVE_REPAIR_SHOPS_NON_DEALER","AUTOMOTIVE_TOP_AND_BODY_SHOPS","AVIATION","BABIES_CLOTHING_AND_SUPPLIES","BABY","BANDS_ORCHESTRAS_ENTERTAINERS","BARBIES","BATH_AND_BODY","BATTERIES","BEAN_BABIES","BEAUTY","BEAUTY_AND_FRAGRANCES","BED_AND_BATH","BICYCLE_SHOPS_SALES_AND_SERVICE","BICYCLES_AND_ACCESSORIES","BILLIARD_POOL_ESTABLISHMENTS","BOAT_DEALERS","BOAT_RENTALS_AND_LEASING","BOATING_SAILING_AND_ACCESSORIES","BOOKS","BOOKS_AND_MAGAZINES","BOOKS_MANUSCRIPTS","BOOKS_PERIODICALS_AND_NEWSPAPERS","BOWLING_ALLEYS","BULLETIN_BOARD","BUS_LINE","BUS_LINES_CHARTERS_TOUR_BUSES","BUSINESS","BUSINESS_AND_SECRETARIAL_SCHOOLS","BUYING_AND_SHOPPING_SERVICES_AND_CLUBS","CABLE_SATELLITE_AND_OTHER_PAY_TELEVISION_AND_RADIO_SERVICES","CABLE_SATELLITE_AND_OTHER_PAY_TV_AND_RADIO","CAMERA_AND_PHOTOGRAPHIC_SUPPLIES","CAMERAS","CAMERAS_AND_PHOTOGRAPHY","CAMPER_RECREATIONAL_AND_UTILITY_TRAILER_DEALERS","CAMPING_AND_OUTDOORS","CAMPING_AND_SURVIVAL","CAR_AND_TRUCK_DEALERS","CAR_AND_TRUCK_DEALERS_USED_ONLY","CAR_AUDIO_AND_ELECTRONICS","CAR_RENTAL_AGENCY","CATALOG_MERCHANT","CATALOG_RETAIL_MERCHANT","CATERING_SERVICES","CHARITY","CHECK_CASHIER","CHILD_CARE_SERVICES","CHILDREN_BOOKS","CHIROPODISTS_PODIATRISTS","CHIROPRACTORS","CIGAR_STORES_AND_STANDS","CIVIC_SOCIAL_FRATERNAL_ASSOCIATIONS","CIVIL_SOCIAL_FRAT_ASSOCIATIONS","CLOTHING","CLOTHING_ACCESSORIES_AND_SHOES","CLOTHING_RENTAL","COFFEE_AND_TEA","COIN_OPERATED_BANKS_AND_CASINOS","COLLECTIBLES","COLLECTION_AGENCY","COLLEGES_AND_UNIVERSITIES","COMMERCIAL_EQUIPMENT","COMMERCIAL_FOOTWEAR","COMMERCIAL_PHOTOGRAPHY","COMMERCIAL_PHOTOGRAPHY_ART_AND_GRAPHICS","COMMERCIAL_SPORTS_PROFESSIONA","COMMODITIES_AND_FUTURES_EXCHANGE","COMPUTER_AND_DATA_PROCESSING_SERVICES","COMPUTER_HARDWARE_AND_SOFTWARE","COMPUTER_MAINTENANCE_REPAIR_AND_SERVICES_NOT_ELSEWHERE_CLAS","CONSTRUCTION","CONSTRUCTION_MATERIALS_NOT_ELSEWHERE_CLASSIFIED","CONSULTING_SERVICES","CONSUMER_CREDIT_REPORTING_AGENCIES","CONVALESCENT_HOMES","COSMETIC_STORES","COUNSELING_SERVICES_DEBT_MARRIAGE_PERSONAL","COUNTERFEIT_CURRENCY_AND_STAMPS","COUNTERFEIT_ITEMS","COUNTRY_CLUBS","COURIER_SERVICES","COURIER_SERVICES_AIR_AND_GROUND_AND_FREIGHT_FORWARDERS","COURT_COSTS_ALIMNY_CHILD_SUPT","COURT_COSTS_INCLUDING_ALIMONY_AND_CHILD_SUPPORT_COURTS_OF_LAW","CREDIT_CARDS","CREDIT_UNION","CULTURE_AND_RELIGION","DAIRY_PRODUCTS_STORES","DANCE_HALLS_STUDIOS_AND_SCHOOLS","DECORATIVE","DENTAL","DENTISTS_AND_ORTHODONTISTS","DEPARTMENT_STORES","DESKTOP_PCS","DEVICES","DIECAST_TOYS_VEHICLES","DIGITAL_GAMES","DIGITAL_MEDIA_BOOKS_MOVIES_MUSIC","DIRECT_MARKETING","DIRECT_MARKETING_CATALOG_MERCHANT","DIRECT_MARKETING_INBOUND_TELE","DIRECT_MARKETING_OUTBOUND_TELE","DIRECT_MARKETING_SUBSCRIPTION","DISCOUNT_STORES","DOOR_TO_DOOR_SALES","DRAPERY_WINDOW_COVERING_AND_UPHOLSTERY","DRINKING_PLACES","DRUGSTORE","DURABLE_GOODS","ECOMMERCE_DEVELOPMENT","ECOMMERCE_SERVICES","EDUCATIONAL_AND_TEXTBOOKS","ELECTRIC_RAZOR_STORES","ELECTRICAL_AND_SMALL_APPLIANCE_REPAIR","ELECTRICAL_CONTRACTORS","ELECTRICAL_PARTS_AND_EQUIPMENT","ELECTRONIC_CASH","ELEMENTARY_AND_SECONDARY_SCHOOLS","EMPLOYMENT","ENTERTAINERS","ENTERTAINMENT_AND_MEDIA","EQUIP_TOOL_FURNITURE_AND_APPLIANCE_RENTAL_AND_LEASING","ESCROW","EVENT_AND_WEDDING_PLANNING","EXERCISE_AND_FITNESS","EXERCISE_EQUIPMENT","EXTERMINATING_AND_DISINFECTING_SERVICES","FABRICS_AND_SEWING","FAMILY_CLOTHING_STORES","FASHION_JEWELRY","FAST_FOOD_RESTAURANTS","FICTION_AND_NONFICTION","FINANCE_COMPANY","FINANCIAL_AND_INVESTMENT_ADVICE","FINANCIAL_INSTITUTIONS_MERCHANDISE_AND_SERVICES","FIREARM_ACCESSORIES","FIREARMS_WEAPONS_AND_KNIVES","FIREPLACE_AND_FIREPLACE_SCREENS","FIREWORKS","FISHING","FLORISTS","FLOWERS","FOOD_DRINK_AND_NUTRITION","FOOD_PRODUCTS","FOOD_RETAIL_AND_SERVICE","FRAGRANCES_AND_PERFUMES","FREEZER_AND_LOCKER_MEAT_PROVISIONERS","FUEL_DEALERS_FUEL_OIL_WOOD_AND_COAL","FUEL_DEALERS_NON_AUTOMOTIVE","FUNERAL_SERVICES_AND_CREMATORIES","FURNISHING_AND_DECORATING","FURNITURE","FURRIERS_AND_FUR_SHOPS","GADGETS_AND_OTHER_ELECTRONICS","GAMBLING","GAME_SOFTWARE","GAMES","GARDEN_SUPPLIES","GENERAL","GENERAL_CONTRACTORS","GENERAL_GOVERNMENT","GENERAL_SOFTWARE","GENERAL_TELECOM","GIFTS_AND_FLOWERS","GLASS_PAINT_AND_WALLPAPER_STORES","GLASSWARE_CRYSTAL_STORES","GOVERNMENT","GOVERNMENT_IDS_AND_LICENSES","GOVERNMENT_LICENSED_ON_LINE_CASINOS_ON_LINE_GAMBLING","GOVERNMENT_OWNED_LOTTERIES","GOVERNMENT_SERVICES","GRAPHIC_AND_COMMERCIAL_DESIGN","GREETING_CARDS","GROCERY_STORES_AND_SUPERMARKETS","HARDWARE_AND_TOOLS","HARDWARE_EQUIPMENT_AND_SUPPLIES","HAZARDOUS_RESTRICTED_AND_PERISHABLE_ITEMS","HEALTH_AND_BEAUTY_SPAS","HEALTH_AND_NUTRITION","HEALTH_AND_PERSONAL_CARE","HEARING_AIDS_SALES_AND_SUPPLIES","HEATING_PLUMBING_AC","HIGH_RISK_MERCHANT","HIRING_SERVICES","HOBBIES_TOYS_AND_GAMES","HOME_AND_GARDEN","HOME_AUDIO","HOME_DECOR","HOME_ELECTRONICS","HOSPITALS","HOTELS_MOTELS_INNS_RESORTS","HOUSEWARES","HUMAN_PARTS_AND_REMAINS","HUMOROUS_GIFTS_AND_NOVELTIES","HUNTING","IDS_LICENSES_AND_PASSPORTS","ILLEGAL_DRUGS_AND_PARAPHERNALIA","INDUSTRIAL","INDUSTRIAL_AND_MANUFACTURING_SUPPLIES","INSURANCE_AUTO_AND_HOME","INSURANCE_DIRECT","INSURANCE_LIFE_AND_ANNUITY","INSURANCE_SALES_UNDERWRITING","INSURANCE_UNDERWRITING_PREMIUMS","INTERNET_AND_NETWORK_SERVICES","INTRA_COMPANY_PURCHASES","LABORATORIES_DENTAL_MEDICAL","LANDSCAPING","LANDSCAPING_AND_HORTICULTURAL_SERVICES","LAUNDRY_CLEANING_SERVICES","LEGAL","LEGAL_SERVICES_AND_ATTORNEYS","LOCAL_DELIVERY_SERVICE","LOCKSMITH","LODGING_AND_ACCOMMODATIONS","LOTTERY_AND_CONTESTS","LUGGAGE_AND_LEATHER_GOODS","LUMBER_AND_BUILDING_MATERIALS","MAGAZINES","MAINTENANCE_AND_REPAIR_SERVICES","MAKEUP_AND_COSMETICS","MANUAL_CASH_DISBURSEMENTS","MASSAGE_PARLORS","MEDICAL","MEDICAL_AND_PHARMACEUTICAL","MEDICAL_CARE","MEDICAL_EQUIPMENT_AND_SUPPLIES","MEDICAL_SERVICES","MEETING_PLANNERS","MEMBERSHIP_CLUBS_AND_ORGANIZATIONS","MEMBERSHIP_COUNTRY_CLUBS_GOLF","MEMORABILIA","MEN_AND_BOY_CLOTHING_AND_ACCESSORY_STORES","MEN_CLOTHING","MERCHANDISE","METAPHYSICAL","MILITARIA","MILITARY_AND_CIVIL_SERVICE_UNIFORMS","MISC","MISCELLANEOUS_GENERAL_SERVICES","MISCELLANEOUS_REPAIR_SHOPS_AND_RELATED_SERVICES","MODEL_KITS","MONEY_TRANSFER_MEMBER_FINANCIAL_INSTITUTION","MONEY_TRANSFER_MERCHANT","MOTION_PICTURE_THEATERS","MOTOR_FREIGHT_CARRIERS_AND_TRUCKING","MOTOR_HOME_AND_RECREATIONAL_VEHICLE_RENTAL","MOTOR_HOMES_DEALERS","MOTOR_VEHICLE_SUPPLIES_AND_NEW_PARTS","MOTORCYCLE_DEALERS","MOTORCYCLES","MOVIE","MOVIE_TICKETS","MOVING_AND_STORAGE","MULTI_LEVEL_MARKETING","MUSIC_CDS_CASSETTES_AND_ALBUMS","MUSIC_STORE_INSTRUMENTS_AND_SHEET_MUSIC","NETWORKING","NEW_AGE","NEW_PARTS_AND_SUPPLIES_MOTOR_VEHICLE","NEWS_DEALERS_AND_NEWSTANDS","NON_DURABLE_GOODS","NON_FICTION","NON_PROFIT_POLITICAL_AND_RELIGION","NONPROFIT","NOVELTIES","OEM_SOFTWARE","OFFICE_SUPPLIES_AND_EQUIPMENT","ONLINE_DATING","ONLINE_GAMING","ONLINE_GAMING_CURRENCY","ONLINE_SERVICES","OOUTBOUND_TELEMARKETING_MERCH","OPHTHALMOLOGISTS_OPTOMETRIST","OPTICIANS_AND_DISPENSING","ORTHOPEDIC_GOODS_PROSTHETICS","OSTEOPATHS","OTHER","PACKAGE_TOUR_OPERATORS","PAINTBALL","PAINTS_VARNISHES_AND_SUPPLIES","PARKING_LOTS_AND_GARAGES","PARTS_AND_ACCESSORIES","PAWN_SHOPS","PAYCHECK_LENDER_OR_CASH_ADVANCE","PERIPHERALS","PERSONALIZED_GIFTS","PET_SHOPS_PET_FOOD_AND_SUPPLIES","PETROLEUM_AND_PETROLEUM_PRODUCTS","PETS_AND_ANIMALS","PHOTOFINISHING_LABORATORIES_PHOTO_DEVELOPING","PHOTOGRAPHIC_STUDIOS_PORTRAITS","PHOTOGRAPHY","PHYSICAL_GOOD","PICTURE_VIDEO_PRODUCTION","PIECE_GOODS_NOTIONS_AND_OTHER_DRY_GOODS","PLANTS_AND_SEEDS","PLUMBING_AND_HEATING_EQUIPMENTS_AND_SUPPLIES","POLICE_RELATED_ITEMS","POLITICAL_ORGANIZATIONS","POSTAL_SERVICES_GOVERNMENT_ONLY","POSTERS","PREPAID_AND_STORED_VALUE_CARDS","PRESCRIPTION_DRUGS","PROMOTIONAL_ITEMS","PUBLIC_WAREHOUSING_AND_STORAGE","PUBLISHING_AND_PRINTING","PUBLISHING_SERVICES","RADAR_DECTORS","RADIO_TELEVISION_AND_STEREO_REPAIR","REAL_ESTATE","REAL_ESTATE_AGENT","REAL_ESTATE_AGENTS_AND_MANAGERS_RENTALS","RELIGION_AND_SPIRITUALITY_FOR_PROFIT","RELIGIOUS","RELIGIOUS_ORGANIZATIONS","REMITTANCE","RENTAL_PROPERTY_MANAGEMENT","RESIDENTIAL","RETAIL","RETAIL_FINE_JEWELRY_AND_WATCHES","REUPHOLSTERY_AND_FURNITURE_REPAIR","RINGS","ROOFING_SIDING_SHEET_METAL","RUGS_AND_CARPETS","SCHOOLS_AND_COLLEGES","SCIENCE_FICTION","SCRAPBOOKING","SCULPTURES","SECURITIES_BROKERS_AND_DEALERS","SECURITY_AND_SURVEILLANCE","SECURITY_AND_SURVEILLANCE_EQUIPMENT","SECURITY_BROKERS_AND_DEALERS","SEMINARS","SERVICE_STATIONS","SERVICES","SEWING_NEEDLEWORK_FABRIC_AND_PIECE_GOODS_STORES","SHIPPING_AND_PACKING","SHOE_REPAIR_HAT_CLEANING","SHOE_STORES","SHOES","SNOWMOBILE_DEALERS","SOFTWARE","SPECIALTY_AND_MISC","SPECIALTY_CLEANING_POLISHING_AND_SANITATION_PREPARATIONS","SPECIALTY_OR_RARE_PETS","SPORT_GAMES_AND_TOYS","SPORTING_AND_RECREATIONAL_CAMPS","SPORTING_GOODS","SPORTS_AND_OUTDOORS","SPORTS_AND_RECREATION","STAMP_AND_COIN","STATIONARY_PRINTING_AND_WRITING_PAPER","STENOGRAPHIC_AND_SECRETARIAL_SUPPORT_SERVICES","STOCKS_BONDS_SECURITIES_AND_RELATED_CERTIFICATES","STORED_VALUE_CARDS","SUPPLIES","SUPPLIES_AND_TOYS","SURVEILLANCE_EQUIPMENT","SWIMMING_POOLS_AND_SPAS","SWIMMING_POOLS_SALES_SUPPLIES_SERVICES","TAILORS_AND_ALTERATIONS","TAX_PAYMENTS","TAX_PAYMENTS_GOVERNMENT_AGENCIES","TAXICABS_AND_LIMOUSINES","TELECOMMUNICATION_SERVICES","TELEPHONE_CARDS","TELEPHONE_EQUIPMENT","TELEPHONE_SERVICES","THEATER","TIRE_RETREADING_AND_REPAIR","TOLL_OR_BRIDGE_FEES","TOOLS_AND_EQUIPMENT","TOURIST_ATTRACTIONS_AND_EXHIBITS","TOWING_SERVICE","TOYS_AND_GAMES","TRADE_AND_VOCATIONAL_SCHOOLS","TRADEMARK_INFRINGEMENT","TRAILER_PARKS_AND_CAMPGROUNDS","TRAINING_SERVICES","TRANSPORTATION_SERVICES","TRAVEL","TRUCK_AND_UTILITY_TRAILER_RENTALS","TRUCK_STOP","TYPESETTING_PLATE_MAKING_AND_RELATED_SERVICES","USED_MERCHANDISE_AND_SECONDHAND_STORES","USED_PARTS_MOTOR_VEHICLE","UTILITIES","UTILITIES_ELECTRIC_GAS_WATER_SANITARY","VARIETY_STORES","VEHICLE_SALES","VEHICLE_SERVICE_AND_ACCESSORIES","VIDEO_EQUIPMENT","VIDEO_GAME_ARCADES_ESTABLISH","VIDEO_GAMES_AND_SYSTEMS","VIDEO_TAPE_RENTAL_STORES","VINTAGE_AND_COLLECTIBLE_VEHICLES","VINTAGE_AND_COLLECTIBLES","VITAMINS_AND_SUPPLEMENTS","VOCATIONAL_AND_TRADE_SCHOOLS","WATCH_CLOCK_AND_JEWELRY_REPAIR","WEB_HOSTING_AND_DESIGN","WELDING_REPAIR","WHOLESALE_CLUBS","WHOLESALE_FLORIST_SUPPLIERS","WHOLESALE_PRESCRIPTION_DRUGS","WILDLIFE_PRODUCTS","WIRE_TRANSFER","WIRE_TRANSFER_AND_MONEY_ORDER","WOMEN_ACCESSORY_SPECIALITY","WOMEN_CLOTHING"]}}},"description":{"required":["op"],"type":"object","properties":{"op":{"type":"string","description":"The remove operation does not require a value","enum":["add","remove","replace"]},"value":{"maxLength":256,"minLength":1,"type":"string","description":"The product description"}}}}}}
```

## The startTime object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"startTime":{"type":"object","properties":{"op":{"type":"string","enum":["replace"]},"value":{"type":"string","description":"The date and time when the subscription started","format":"date"}}}}}}
```

## The customId object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"customId":{"required":["value"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace"]},"value":{"maxLength":127,"minLength":1,"pattern":"^[ -~]+","type":"string","description":"The custom id for the subscription. Can be invoice id"}}}}}}
```

## The planPaymentPreferencesAutoBillOutstanding object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"planPaymentPreferencesAutoBillOutstanding":{"required":["value"],"type":"object","properties":{"op":{"type":"string","enum":["replace"]},"value":{"type":"boolean","description":"Indicates whether to automatically bill the outstanding amount in the next billing cycle"}}}}}}
```

## The value object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"value":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The fixed amount to charge for the subscription. The changes to fixed amount are applicable to both existing and future subscriptions. For existing subscriptions, payments within 10 days of price change are not affected"}}}}
```

## The planBillingCyclesPricingSchemeFixedPrice object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"planBillingCyclesPricingSchemeFixedPrice":{"required":["sequence","value"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace"]},"value":{"$ref":"#/components/schemas/value"},"sequence":{"type":"integer","description":"The order of the cycle to update"}}},"value":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The fixed amount to charge for the subscription. The changes to fixed amount are applicable to both existing and future subscriptions. For existing subscriptions, payments within 10 days of price change are not affected"}}}}
```

## The planBillingCyclesTotalCycles object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"planBillingCyclesTotalCycles":{"required":["sequence","value"],"type":"object","properties":{"op":{"type":"string","enum":["replace"]},"value":{"type":"integer","description":"The number of times this billing cycle gets executed"},"sequence":{"type":"integer","description":"The order of the cycle to update"}}}}}}
```

## The Model55 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model55":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The pricing amount for the tier"}}}}
```

## The Model56 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model56":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"integer","description":"The starting quantity for the tier"},"endingQuantity":{"type":"integer","description":"The ending quantity for the tier. Optional for the last tier"},"amount":{"$ref":"#/components/schemas/Model55"}}},"Model55":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The pricing amount for the tier"}}}}
```

## The Model57 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model57":{"type":"array","items":{"$ref":"#/components/schemas/Model56"}},"Model56":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"integer","description":"The starting quantity for the tier"},"endingQuantity":{"type":"integer","description":"The ending quantity for the tier. Optional for the last tier"},"amount":{"$ref":"#/components/schemas/Model55"}}},"Model55":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The pricing amount for the tier"}}}}
```

## The planBillingCyclesPricingSchemeTiers object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"planBillingCyclesPricingSchemeTiers":{"required":["sequence"],"type":"object","properties":{"op":{"type":"string","enum":["replace"]},"value":{"$ref":"#/components/schemas/Model57"},"sequence":{"type":"integer","description":"The order of the cycle to update"}}},"Model57":{"type":"array","items":{"$ref":"#/components/schemas/Model56"}},"Model56":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"integer","description":"The starting quantity for the tier"},"endingQuantity":{"type":"integer","description":"The ending quantity for the tier. Optional for the last tier"},"amount":{"$ref":"#/components/schemas/Model55"}}},"Model55":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The pricing amount for the tier"}}}}
```

## The planTaxesPercentage object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"planTaxesPercentage":{"required":["value"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace"]},"value":{"type":"integer","description":"The tax percentage on the billing amount"}}}}}}
```

## The planTaxesInclusive object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"planTaxesInclusive":{"required":["value"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace"]},"value":{"type":"boolean","description":"Indicates whether the tax was already included in the billing amount"}}}}}}
```

## The subscriberShippingAddress object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"subscriberShippingAddress":{"required":["value"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace"]},"value":{"$ref":"#/components/schemas/Model12"}}},"Model12":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Model11"},"address":{"$ref":"#/components/schemas/billingAddress"}},"description":"The shipping details"},"Model11":{"type":"object","properties":{"fullName":{"maxLength":300,"type":"string"}},"description":"The name of the person to whom to ship the items"},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"}}}}
```

## The billingInfoOutstandingBalance object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"billingInfoOutstandingBalance":{"required":["value"],"type":"object","properties":{"op":{"type":"string","enum":["replace"]},"value":{"$ref":"#/components/schemas/outstandingBalance"}}},"outstandingBalance":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The total pending bill amount, to be paid by the subscriber"}}}}
```

## The Model58 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model58":{"required":["value"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace"]},"value":{"$ref":"#/components/schemas/Model19"}}},"Model19":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Shipping charges amount"}}}}
```

## The Model59 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model59":{"required":["paymentProviderContract"],"type":"object","properties":{"paymentProviderContract":{"type":"string","description":"PayPal Payment Provider Contract UUID"},"startTime":{"$ref":"#/components/schemas/startTime"},"customId":{"$ref":"#/components/schemas/customId"},"planPaymentPreferencesAutoBillOutstanding":{"$ref":"#/components/schemas/planPaymentPreferencesAutoBillOutstanding"},"planBillingCyclesPricingSchemeFixedPrice":{"$ref":"#/components/schemas/planBillingCyclesPricingSchemeFixedPrice"},"planBillingCyclesTotalCycles":{"$ref":"#/components/schemas/planBillingCyclesTotalCycles"},"planBillingCyclesPricingSchemeTiers":{"$ref":"#/components/schemas/planBillingCyclesPricingSchemeTiers"},"planTaxesPercentage":{"$ref":"#/components/schemas/planTaxesPercentage"},"planTaxesInclusive":{"$ref":"#/components/schemas/planTaxesInclusive"},"subscriberShippingAddress":{"$ref":"#/components/schemas/subscriberShippingAddress"},"billingInfoOutstandingBalance":{"$ref":"#/components/schemas/billingInfoOutstandingBalance"},"shippingAmount":{"$ref":"#/components/schemas/Model58"}}},"startTime":{"type":"object","properties":{"op":{"type":"string","enum":["replace"]},"value":{"type":"string","description":"The date and time when the subscription started","format":"date"}}},"customId":{"required":["value"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace"]},"value":{"maxLength":127,"minLength":1,"pattern":"^[ -~]+","type":"string","description":"The custom id for the subscription. Can be invoice id"}}},"planPaymentPreferencesAutoBillOutstanding":{"required":["value"],"type":"object","properties":{"op":{"type":"string","enum":["replace"]},"value":{"type":"boolean","description":"Indicates whether to automatically bill the outstanding amount in the next billing cycle"}}},"planBillingCyclesPricingSchemeFixedPrice":{"required":["sequence","value"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace"]},"value":{"$ref":"#/components/schemas/value"},"sequence":{"type":"integer","description":"The order of the cycle to update"}}},"value":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The fixed amount to charge for the subscription. The changes to fixed amount are applicable to both existing and future subscriptions. For existing subscriptions, payments within 10 days of price change are not affected"},"planBillingCyclesTotalCycles":{"required":["sequence","value"],"type":"object","properties":{"op":{"type":"string","enum":["replace"]},"value":{"type":"integer","description":"The number of times this billing cycle gets executed"},"sequence":{"type":"integer","description":"The order of the cycle to update"}}},"planBillingCyclesPricingSchemeTiers":{"required":["sequence"],"type":"object","properties":{"op":{"type":"string","enum":["replace"]},"value":{"$ref":"#/components/schemas/Model57"},"sequence":{"type":"integer","description":"The order of the cycle to update"}}},"Model57":{"type":"array","items":{"$ref":"#/components/schemas/Model56"}},"Model56":{"required":["amount","startingQuantity"],"type":"object","properties":{"startingQuantity":{"type":"integer","description":"The starting quantity for the tier"},"endingQuantity":{"type":"integer","description":"The ending quantity for the tier. Optional for the last tier"},"amount":{"$ref":"#/components/schemas/Model55"}}},"Model55":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The pricing amount for the tier"},"planTaxesPercentage":{"required":["value"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace"]},"value":{"type":"integer","description":"The tax percentage on the billing amount"}}},"planTaxesInclusive":{"required":["value"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace"]},"value":{"type":"boolean","description":"Indicates whether the tax was already included in the billing amount"}}},"subscriberShippingAddress":{"required":["value"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace"]},"value":{"$ref":"#/components/schemas/Model12"}}},"Model12":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Model11"},"address":{"$ref":"#/components/schemas/billingAddress"}},"description":"The shipping details"},"Model11":{"type":"object","properties":{"fullName":{"maxLength":300,"type":"string"}},"description":"The name of the person to whom to ship the items"},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"},"billingInfoOutstandingBalance":{"required":["value"],"type":"object","properties":{"op":{"type":"string","enum":["replace"]},"value":{"$ref":"#/components/schemas/outstandingBalance"}}},"outstandingBalance":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"The total pending bill amount, to be paid by the subscriber"},"Model58":{"required":["value"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace"]},"value":{"$ref":"#/components/schemas/Model19"}}},"Model19":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"minimum":0,"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Shipping charges amount"}}}}
```

## The Model60 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model60":{"required":["percentage"],"type":"object","properties":{"percentage":{"type":"string","description":"The tax percentage on the billing amount."}}}}}}
```

## The Model61 object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"Model61":{"required":["paymentProviderContract"],"type":"object","properties":{"paymentProviderContract":{"type":"string","description":"PayPal Payment Provider Contract UUID"},"description":{"maxLength":127,"type":"string","description":"The detailed description of the plan."},"paymentPreferences":{"$ref":"#/components/schemas/paymentPreferences"},"taxes":{"$ref":"#/components/schemas/Model60"}}},"paymentPreferences":{"type":"object","properties":{"autoBillOutstanding":{"type":"boolean","description":"Indicates whether to automatically bill the outstanding amount in the next billing cycle."},"setupFee":{"$ref":"#/components/schemas/setupFee"},"setupFeeFailureAction":{"type":"string","description":"The action to take on the subscription if the initial payment for the setup fails.","enum":["CONTINUE","CANCEL"]},"paymentFailureThreshold":{"type":"number","description":"The maximum number of payment failures before a subscription is suspended."}},"description":"The payment preferences for a subscription."},"setupFee":{"required":["currencyCode","value"],"type":"object","properties":{"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"}},"description":"The initial set-up fee for the service."},"Model60":{"required":["percentage"],"type":"object","properties":{"percentage":{"type":"string","description":"The tax percentage on the billing amount."}}}}}}
```

## The updateTransaction object

```json
{"openapi":"3.0.1","info":{"title":"PayPal eComm API","version":"1.6.0"},"components":{"schemas":{"updateTransaction":{"type":"object","properties":{"intent":{"type":"string","description":"Intent of this transaction","enum":["AUTHORIZE","CAPTURE"]},"payer":{"$ref":"#/components/schemas/customer"},"merchantReference":{"type":"string","description":"The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer.","maxLength":127},"description":{"type":"string","description":"Purchase description","maxLength":127},"shipping":{"$ref":"#/components/schemas/shipping"},"dynamicDescriptor":{"type":"string","description":"If an Order is paid using the \"PayPal Wallet\" the statement descriptor will appear in following format on the payer card statement:  PAYPAL_prefix+(space)+merchant_descriptor+(space)+dynamicDescriptor.  The PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the statement. <br />  For example, <br/>  * The PayPal prefix toggle is PAYPAL <br/>  * The merchant descriptor in the profile is Janes Gift <br/>  * The soft descriptor is 800-123-1234 </br> Then, the statement descriptor on the card is PAYPAL * Janes Gift 80.","maxLength":22},"amount":{"$ref":"#/components/schemas/Model22"},"detailedAmount":{"$ref":"#/components/schemas/detailedAmount"}}},"customer":{"type":"object","properties":{"email":{"maxLength":255,"type":"string","description":"Customer email address"},"payerId":{"pattern":"^[2-9A-HJ-NP-Z]{13}$","type":"string","description":"The PayPal-assigned ID for the payer"},"phoneNumber":{"$ref":"#/components/schemas/Phone_number"},"birthDate":{"type":"string","description":"Date of birth of the customer, 10 characters, ISO-8601 (YYYY-MM-DD)","format":"date"},"identification":{"$ref":"#/components/schemas/identification"},"address":{"$ref":"#/components/schemas/address"},"firstName":{"type":"string","description":"Customer first name"},"lastName":{"type":"string","description":"Customer last name"}},"description":"Customer details"},"Phone_number":{"required":["value"],"type":"object","properties":{"phoneType":{"type":"string","description":"Customer phone type","enum":["FAX","HOME","MOBILE","OTHER","PAGER"]},"value":{"type":"string","description":"Customer phone number"}},"description":"Phone number"},"identification":{"required":["taxIdentificationNumber","taxIdentificationType"],"type":"object","properties":{"taxIdentificationNumber":{"maxLength":14,"type":"string","description":"Customer tax ID. Supported for the PayPal payment method only. Typically, the tax ID is 11 characters long for individuals and 14 characters long for businesses."},"taxIdentificationType":{"type":"string","description":"The customer tax ID type.","enum":["BR_CNPJ","BR_CPF"]}},"description":"Customer identification"},"address":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Customer billing address"},"shipping":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/billingAddress"},"fullName":{"type":"string","description":"Full Name"}},"description":"Shipping details"},"billingAddress":{"required":["country","postalCode"],"type":"object","properties":{"country":{"maxLength":2,"minLength":2,"pattern":"^([A-Z]{2}|C2)$","type":"string","description":"The two-character ISO 3166-1 code that identifies the country or region."},"postalCode":{"maxLength":60,"type":"string","description":"The postal code, which is the zip code or equivalent.  Typically required for countries with a postal code or an equivalent."},"countrySubdivision":{"maxLength":300,"type":"string","description":"The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision."},"city":{"maxLength":120,"type":"string","description":"A city, town, or village. Smaller than admin_area_level_1"},"addressLine2":{"maxLength":300,"type":"string","description":"The second line of the address. For example, suite or apartment number."},"addressLine1":{"maxLength":300,"type":"string","description":"The first line of the address. For example, number or street.  For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address."}},"description":"Shipping Address details"},"Model22":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Total transaction amount"},"detailedAmount":{"type":"object","properties":{"discount":{"$ref":"#/components/schemas/discount"},"shippingDiscount":{"$ref":"#/components/schemas/shippingDiscount"},"insurance":{"$ref":"#/components/schemas/insurance"},"handling":{"$ref":"#/components/schemas/handling"},"shipping":{"$ref":"#/components/schemas/Model25"}},"description":"Detailed amount"},"discount":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Discount amount"},"shippingDiscount":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Shipping discount amount"},"insurance":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Insurance fee amount"},"handling":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Handling fee amount"},"Model25":{"required":["currencyCode","value"],"type":"object","properties":{"value":{"type":"integer","description":"Integer amount value (100 is 1.00)"},"currencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Currency code (ISO-4217)","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"description":"Shipping fee amount"}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.verifone.com/api-reference/open-api-references/paypal-ecomm/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.