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://my-gala.com/v2/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=true",
"cancel_url": "https://my-gala.com/v2/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-74B59534XP7498437GUDN2MA",
"name": "Regular Payments",
"type": "REGULAR",
"frequency": "Month",
"amount": {
"currency": "USD",
"value": "100"
},
"cycles": "12",
"charge_models": [
{
"id": "CHM-12B56596AG414093VGUDN2MA",
"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://my-gala.com/v2/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=true",
"cancel_url": "https://my-gala.com/v2/vendor/paypal/rest-api-sdk-php/sample/billing/ExecuteAgreement.php?success=false",
"auto_bill_amount": "YES",
"initial_fail_amount_action": "CONTINUE"
},
"id": "P-7H086575LP8426746GUDN2MA",
"state": "CREATED",
"create_time": "2025-02-23T22:56:37.168Z",
"update_time": "2025-02-23T22:56:37.168Z",
"links": [
{
"href": "https://api.sandbox.paypal.com/v1/payments/billing-plans/P-7H086575LP8426746GUDN2MA",
"rel": "self",
"method": "GET"
}
]
} 