PayPal REST API Samples

1. Created Plan

Plan with ID: P-86R49358R8600722Y6KH2PMY

Request Object

{
    "name": "T-Shirt of the Month Club Plan",
    "description": "Template creation.",
    "type": "fixed",
    "payment_definitions": [
        {
            "name": "Regular Payments",
            "type": "REGULAR",
            "frequency": "Month",
            "frequency_interval": "2",
            "cycles": "12",
            "amount": {
                "value": "100",
                "currency": "USD"
            },
            "charge_models": [
                {
                    "type": "SHIPPING",
                    "amount": {
                        "value": "10",
                        "currency": "USD"
                    }
                }
            ]
        }
    ],
    "merchant_preferences": {
        "return_url": "https://www.server2-tls.searchquestuk.com/paypal/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "https://www.server2-tls.searchquestuk.com/paypal/sample/billing/ExecuteAgreement.php?success=false",
        "auto_bill_amount": "yes",
        "initial_fail_amount_action": "CONTINUE",
        "max_fail_attempts": "0",
        "setup_fee": {
            "value": "1",
            "currency": "USD"
        }
    }
}

Response Object

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

Warning: sizeof(): Parameter must be an array or an object that implements Countable in /home/server2tls/public_html/paypal/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php on line 176

{
    "name": "T-Shirt of the Month Club Plan",
    "description": "Template creation.",
    "type": "FIXED",
    "payment_definitions": [
        {
            "id": "PD-7A2987130J059093S6KH2PMY",
            "name": "Regular Payments",
            "type": "REGULAR",
            "frequency": "Month",
            "amount": {
                "currency": "USD",
                "value": "100"
            },
            "cycles": "12",
            "charge_models": [
                {
                    "id": "CHM-66U540660M309841P6KH2PMY",
                    "type": "SHIPPING",
                    "amount": {
                        "currency": "USD",
                        "value": "10"
                    }
                }
            ],
            "frequency_interval": "2"
        }
    ],
    "merchant_preferences": {
        "setup_fee": {
            "currency": "USD",
            "value": "1"
        },
        "max_fail_attempts": "0",
        "return_url": "https://www.server2-tls.searchquestuk.com/paypal/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "https://www.server2-tls.searchquestuk.com/paypal/sample/billing/ExecuteAgreement.php?success=false",
        "auto_bill_amount": "YES",
        "initial_fail_amount_action": "CONTINUE"
    },
    "id": "P-86R49358R8600722Y6KH2PMY",
    "state": "CREATED",
    "create_time": "2026-08-11T20:42:08.691Z",
    "update_time": "2026-08-11T20:42:08.691Z",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans/P-86R49358R8600722Y6KH2PMY",
            "rel": "self",
            "method": "GET"
        }
    ]
}

Request
Response

Request Object

{
    "name": "T-Shirt of the Month Club Plan",
    "description": "Template creation.",
    "type": "fixed",
    "payment_definitions": [
        {
            "name": "Regular Payments",
            "type": "REGULAR",
            "frequency": "Month",
            "frequency_interval": "2",
            "cycles": "12",
            "amount": {
                "value": "100",
                "currency": "USD"
            },
            "charge_models": [
                {
                    "type": "SHIPPING",
                    "amount": {
                        "value": "10",
                        "currency": "USD"
                    }
                }
            ]
        }
    ],
    "merchant_preferences": {
        "return_url": "https://www.server2-tls.searchquestuk.com/paypal/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "https://www.server2-tls.searchquestuk.com/paypal/sample/billing/ExecuteAgreement.php?success=false",
        "auto_bill_amount": "yes",
        "initial_fail_amount_action": "CONTINUE",
        "max_fail_attempts": "0",
        "setup_fee": {
            "value": "1",
            "currency": "USD"
        }
    }
}

Response Object

{
    "name": "T-Shirt of the Month Club Plan",
    "description": "Template creation.",
    "type": "FIXED",
    "payment_definitions": [
        {
            "id": "PD-7A2987130J059093S6KH2PMY",
            "name": "Regular Payments",
            "type": "REGULAR",
            "frequency": "Month",
            "amount": {
                "currency": "USD",
                "value": "100"
            },
            "cycles": "12",
            "charge_models": [
                {
                    "id": "CHM-66U540660M309841P6KH2PMY",
                    "type": "SHIPPING",
                    "amount": {
                        "currency": "USD",
                        "value": "10"
                    }
                }
            ],
            "frequency_interval": "2"
        }
    ],
    "merchant_preferences": {
        "setup_fee": {
            "currency": "USD",
            "value": "1"
        },
        "max_fail_attempts": "0",
        "return_url": "https://www.server2-tls.searchquestuk.com/paypal/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "https://www.server2-tls.searchquestuk.com/paypal/sample/billing/ExecuteAgreement.php?success=false",
        "auto_bill_amount": "YES",
        "initial_fail_amount_action": "CONTINUE"
    },
    "id": "P-86R49358R8600722Y6KH2PMY",
    "state": "CREATED",
    "create_time": "2026-08-11T20:42:08.691Z",
    "update_time": "2026-08-11T20:42:08.691Z",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans/P-86R49358R8600722Y6KH2PMY",
            "rel": "self",
            "method": "GET"
        }
    ]
}

2. List of Plans

Request Object

Array
(
    [page_size] => 2
)

Response Object

{
    "plans": [
        {
            "id": "P-1HK51856FJ5423311QKKWJ7Y",
            "state": "CREATED",
            "name": "T-Shirt of the Month Club Plan",
            "description": "Template creation.",
            "type": "INFINITE",
            "create_time": "2015-08-31T07:07:52.959Z",
            "update_time": "2015-08-31T07:07:52.959Z",
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans/P-1HK51856FJ5423311QKKWJ7Y",
                    "rel": "self",
                    "method": "GET"
                }
            ]
        },
        {
            "id": "P-8UL11311918337642QKYPEKI",
            "state": "CREATED",
            "name": "T-Shirt of the Month Club Plan",
            "description": "Template creation.",
            "type": "FIXED",
            "create_time": "2015-08-31T07:37:58.569Z",
            "update_time": "2015-08-31T07:37:58.569Z",
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans/P-8UL11311918337642QKYPEKI",
                    "rel": "self",
                    "method": "GET"
                }
            ]
        }
    ],
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans?page_size=2&page=0&start=1&status=created",
            "rel": "start",
            "method": "GET"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans?page_size=2&page=1&status=created",
            "rel": "next_page",
            "method": "GET"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans?page_size=2&page=63970&status=created",
            "rel": "last",
            "method": "GET"
        }
    ]
}

Request
Response

Request Object

Array
(
    [page_size] => 2
)

Response Object

{
    "plans": [
        {
            "id": "P-1HK51856FJ5423311QKKWJ7Y",
            "state": "CREATED",
            "name": "T-Shirt of the Month Club Plan",
            "description": "Template creation.",
            "type": "INFINITE",
            "create_time": "2015-08-31T07:07:52.959Z",
            "update_time": "2015-08-31T07:07:52.959Z",
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans/P-1HK51856FJ5423311QKKWJ7Y",
                    "rel": "self",
                    "method": "GET"
                }
            ]
        },
        {
            "id": "P-8UL11311918337642QKYPEKI",
            "state": "CREATED",
            "name": "T-Shirt of the Month Club Plan",
            "description": "Template creation.",
            "type": "FIXED",
            "create_time": "2015-08-31T07:37:58.569Z",
            "update_time": "2015-08-31T07:37:58.569Z",
            "links": [
                {
                    "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans/P-8UL11311918337642QKYPEKI",
                    "rel": "self",
                    "method": "GET"
                }
            ]
        }
    ],
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans?page_size=2&page=0&start=1&status=created",
            "rel": "start",
            "method": "GET"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans?page_size=2&page=1&status=created",
            "rel": "next_page",
            "method": "GET"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans?page_size=2&page=63970&status=created",
            "rel": "last",
            "method": "GET"
        }
    ]
}

❮❮ Back to Samples

1. Created Plan

Request Object

Response Object

Request Object

Response Object

2. List of Plans

Request Object

Response Object

Request Object

Response Object