PayPal REST API Samples

1. Created Plan

Plan with ID: P-8PA972168R2362712RXQGLNQ

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.icentar.eindex.msu.edu.mk/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "https://www.icentar.eindex.msu.edu.mk/vendor/paypal/rest-api-sdk-php/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-4YG38063H1689962CRXQGLNQ",
            "name": "Regular Payments",
            "type": "REGULAR",
            "frequency": "Month",
            "amount": {
                "currency": "USD",
                "value": "100"
            },
            "cycles": "12",
            "charge_models": [
                {
                    "id": "CHM-2M470755365023808RXQGLNQ",
                    "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.icentar.eindex.msu.edu.mk/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "https://www.icentar.eindex.msu.edu.mk/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=false",
        "auto_bill_amount": "YES",
        "initial_fail_amount_action": "CONTINUE"
    },
    "id": "P-8PA972168R2362712RXQGLNQ",
    "state": "CREATED",
    "create_time": "2026-06-03T14:25:54.102Z",
    "update_time": "2026-06-03T14:25:54.102Z",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans/P-8PA972168R2362712RXQGLNQ",
            "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.icentar.eindex.msu.edu.mk/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "https://www.icentar.eindex.msu.edu.mk/vendor/paypal/rest-api-sdk-php/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-4YG38063H1689962CRXQGLNQ",
            "name": "Regular Payments",
            "type": "REGULAR",
            "frequency": "Month",
            "amount": {
                "currency": "USD",
                "value": "100"
            },
            "cycles": "12",
            "charge_models": [
                {
                    "id": "CHM-2M470755365023808RXQGLNQ",
                    "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.icentar.eindex.msu.edu.mk/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "https://www.icentar.eindex.msu.edu.mk/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=false",
        "auto_bill_amount": "YES",
        "initial_fail_amount_action": "CONTINUE"
    },
    "id": "P-8PA972168R2362712RXQGLNQ",
    "state": "CREATED",
    "create_time": "2026-06-03T14:25:54.102Z",
    "update_time": "2026-06-03T14:25:54.102Z",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans/P-8PA972168R2362712RXQGLNQ",
            "rel": "self",
            "method": "GET"
        }
    ]
}

Deprecated: Use of "self" in callables is deprecated in /home/eindexmsu/public_html/icentar/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 152

Deprecated: Use of "self" in callables is deprecated in /home/eindexmsu/public_html/icentar/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 152

Deprecated: Use of "self" in callables is deprecated in /home/eindexmsu/public_html/icentar/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 152

Deprecated: Use of "self" in callables is deprecated in /home/eindexmsu/public_html/icentar/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 152

2. Updated the Plan to Active State

Plan with ID: P-8PA972168R2362712RXQGLNQ

Request Object

[
    {
        "op": "replace",
        "path": "/",
        "value": {
            "state": "ACTIVE"
        }
    }
]

Response Object

{
    "id": "P-8PA972168R2362712RXQGLNQ",
    "state": "ACTIVE",
    "name": "T-Shirt of the Month Club Plan",
    "description": "Template creation.",
    "type": "FIXED",
    "payment_definitions": [
        {
            "id": "PD-4YG38063H1689962CRXQGLNQ",
            "name": "Regular Payments",
            "type": "REGULAR",
            "frequency": "Month",
            "amount": {
                "currency": "USD",
                "value": "100"
            },
            "cycles": "12",
            "charge_models": [
                {
                    "id": "CHM-2M470755365023808RXQGLNQ",
                    "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.icentar.eindex.msu.edu.mk/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "https://www.icentar.eindex.msu.edu.mk/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=false",
        "auto_bill_amount": "YES",
        "initial_fail_amount_action": "CONTINUE"
    },
    "create_time": "2026-06-03T14:25:54.102Z",
    "update_time": "2026-06-03T14:25:54.564Z",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans/P-8PA972168R2362712RXQGLNQ",
            "rel": "self",
            "method": "GET"
        }
    ]
}

Request
Response

Request Object

[
    {
        "op": "replace",
        "path": "/",
        "value": {
            "state": "ACTIVE"
        }
    }
]

Response Object

{
    "id": "P-8PA972168R2362712RXQGLNQ",
    "state": "ACTIVE",
    "name": "T-Shirt of the Month Club Plan",
    "description": "Template creation.",
    "type": "FIXED",
    "payment_definitions": [
        {
            "id": "PD-4YG38063H1689962CRXQGLNQ",
            "name": "Regular Payments",
            "type": "REGULAR",
            "frequency": "Month",
            "amount": {
                "currency": "USD",
                "value": "100"
            },
            "cycles": "12",
            "charge_models": [
                {
                    "id": "CHM-2M470755365023808RXQGLNQ",
                    "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.icentar.eindex.msu.edu.mk/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "https://www.icentar.eindex.msu.edu.mk/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=false",
        "auto_bill_amount": "YES",
        "initial_fail_amount_action": "CONTINUE"
    },
    "create_time": "2026-06-03T14:25:54.102Z",
    "update_time": "2026-06-03T14:25:54.564Z",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans/P-8PA972168R2362712RXQGLNQ",
            "rel": "self",
            "method": "GET"
        }
    ]
}

❮❮ Back to Samples

1. Created Plan

Request Object

Response Object

Request Object

Response Object

2. Updated the Plan to Active State

Request Object

Response Object

Request Object

Response Object