❮❮ Back to Samples

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": "http://mail.moonflix.jaitia.com/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "http://mail.moonflix.jaitia.com/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-6G187927YP256823YJWYUJKQ",
            "name": "Regular Payments",
            "type": "REGULAR",
            "frequency": "Month",
            "amount": {
                "currency": "USD",
                "value": "100"
            },
            "cycles": "12",
            "charge_models": [
                {
                    "id": "CHM-1GA661129U077833CJWYUJKQ",
                    "type": "SHIPPING",
                    "amount": {
                        "currency": "USD",
                        "value": "10"
                    }
                }
            ],
            "frequency_interval": "2"
        }
    ],
    "merchant_preferences": {
        "setup_fee": {
            "currency": "USD",
            "value": "1"
        },
        "max_fail_attempts": "0",
        "return_url": "http://mail.moonflix.jaitia.com/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "http://mail.moonflix.jaitia.com/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=false",
        "auto_bill_amount": "YES",
        "initial_fail_amount_action": "CONTINUE"
    },
    "id": "P-22S3861073239910VJWYUJKQ",
    "state": "CREATED",
    "create_time": "2025-07-27T21:01:59.850Z",
    "update_time": "2025-07-27T21:01:59.850Z",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans/P-22S3861073239910VJWYUJKQ",
            "rel": "self",
            "method": "GET"
        }
    ]
}

Request Object

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

Response Object

{
    "id": "P-22S3861073239910VJWYUJKQ",
    "state": "ACTIVE",
    "name": "T-Shirt of the Month Club Plan",
    "description": "Template creation.",
    "type": "FIXED",
    "payment_definitions": [
        {
            "id": "PD-6G187927YP256823YJWYUJKQ",
            "name": "Regular Payments",
            "type": "REGULAR",
            "frequency": "Month",
            "amount": {
                "currency": "USD",
                "value": "100"
            },
            "cycles": "12",
            "charge_models": [
                {
                    "id": "CHM-1GA661129U077833CJWYUJKQ",
                    "type": "SHIPPING",
                    "amount": {
                        "currency": "USD",
                        "value": "10"
                    }
                }
            ],
            "frequency_interval": "2"
        }
    ],
    "merchant_preferences": {
        "setup_fee": {
            "currency": "USD",
            "value": "1"
        },
        "max_fail_attempts": "0",
        "return_url": "http://mail.moonflix.jaitia.com/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "http://mail.moonflix.jaitia.com/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=false",
        "auto_bill_amount": "YES",
        "initial_fail_amount_action": "CONTINUE"
    },
    "create_time": "2025-07-27T21:01:59.850Z",
    "update_time": "2025-07-27T21:02:00.222Z",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans/P-22S3861073239910VJWYUJKQ",
            "rel": "self",
            "method": "GET"
        }
    ]
}

Request Object

{
    "name": "Base Agreement",
    "description": "Basic Agreement",
    "start_date": "2019-06-17T9:45:04Z",
    "plan": {
        "id": "P-22S3861073239910VJWYUJKQ"
    },
    "payer": {
        "payment_method": "paypal"
    },
    "shipping_address": {
        "line1": "111 First Street",
        "city": "Saratoga",
        "state": "CA",
        "postal_code": "95070",
        "country_code": "US"
    }
}

Response Object

Got Http response code 400 when accessing https://api.sandbox.paypal.com/v1/payments/billing-agreements/.

{
    "name": "VALIDATION_ERROR",
    "debug_id": "cd8d5d6b185df",
    "message": "Invalid request. See details.",
    "information_link": "https://developer.paypal.com/docs/api/payments.billing-agreements#errors",
    "details": [
        {
            "field": "start_date",
            "issue": "Agreement start date is required,should be valid and greater than the current date. Should be consistent with ISO 8601 Format"
        }
    ]
}