❮❮ 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://urhouse.co.nz/assets/paypal/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "http://urhouse.co.nz/assets/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-7KR44756MB599312D3VZOUTY",
            "name": "Regular Payments",
            "type": "REGULAR",
            "frequency": "Month",
            "amount": {
                "currency": "USD",
                "value": "100"
            },
            "cycles": "12",
            "charge_models": [
                {
                    "id": "CHM-4H0564121W373014B3VZOUUA",
                    "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://urhouse.co.nz/assets/paypal/sample/billing/ExecuteAgreement.php?success=true",
        "cancel_url": "http://urhouse.co.nz/assets/paypal/sample/billing/ExecuteAgreement.php?success=false",
        "auto_bill_amount": "YES",
        "initial_fail_amount_action": "CONTINUE"
    },
    "id": "P-2FS700758F71052443VZOUTY",
    "state": "CREATED",
    "create_time": "2018-12-23T23:42:35.087Z",
    "update_time": "2018-12-23T23:42:35.087Z",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans/P-2FS700758F71052443VZOUTY",
            "rel": "self",
            "method": "GET"
        }
    ]
}

Request Object

{
    "name": "DPRP",
    "description": "Payment with credit Card",
    "start_date": "2019-06-17T9:45:04Z",
    "plan": {
        "id": "P-2FS700758F71052443VZOUTY"
    },
    "payer": {
        "payment_method": "credit_card",
        "payer_info": {
            "email": "jaypatel512-facilitator@hotmail.com"
        },
        "funding_instruments": [
            {
                "credit_card": {
                    "type": "visa",
                    "number": "4491759698858890",
                    "expire_month": "12",
                    "expire_year": "2017",
                    "cvv2": "128"
                }
            }
        ]
    },
    "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",
    "details": [
        {
            "field": "payer.funding_instruments[0].credit_card",
            "issue": "Expiration date cannot be in the past."
        }
    ],
    "message": "Invalid request. See details.",
    "information_link": "https://developer.paypal.com/docs/api/payments.billing-agreements#errors",
    "debug_id": "eb39cc5b21594"
}