forked from LiveCarta/PayPal-PHP-SDK
4d481ad104
- Added API Classes, Samples, and Tests - Updated Functional Tests - Updated Documentation with new SDK Name - Updated Few Samples to use newer nicer result page
187 lines
6.5 KiB
JSON
Executable File
187 lines
6.5 KiB
JSON
Executable File
{
|
|
"description": "This operation creates a billing plan having a regular and trial billing period",
|
|
"title": "Billing Plan with regular and trial billing period",
|
|
"runnable": true,
|
|
"operationId": "plan.create",
|
|
"user": {
|
|
"scopes": ["https://uri.paypal.com/services/subscriptions"]
|
|
},
|
|
"credentials": {
|
|
"oauth": {
|
|
"path": "/v1/oauth/token",
|
|
"clientId": "",
|
|
"clientSecret": ""
|
|
}
|
|
},
|
|
"request": {
|
|
"path": "v1/payments/billing-plans/",
|
|
"method": "POST",
|
|
"headers": {},
|
|
"body": {
|
|
"name": "Sample Plan",
|
|
"description": "Plan with regular and trial",
|
|
"type": "fixed",
|
|
"payment_definitions": [
|
|
{
|
|
"name": "Regular Payment Definition",
|
|
"type": "REGULAR",
|
|
"frequency": "MONTH",
|
|
"frequency_interval": "2",
|
|
"amount": {
|
|
"value": "100",
|
|
"currency": "USD"
|
|
},
|
|
"cycles": "12",
|
|
"charge_models": [
|
|
{
|
|
"type": "SHIPPING",
|
|
"amount": {
|
|
"value": "10",
|
|
"currency": "USD"
|
|
}
|
|
},
|
|
{
|
|
"type": "TAX",
|
|
"amount": {
|
|
"value": "12",
|
|
"currency": "USD"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "Trial Payment Definition",
|
|
"type": "trial",
|
|
"frequency": "week",
|
|
"frequency_interval": "5",
|
|
"amount": {
|
|
"value": "9.19",
|
|
"currency": "USD"
|
|
},
|
|
"cycles": "2",
|
|
"charge_models": [
|
|
{
|
|
"type": "SHIPPING",
|
|
"amount": {
|
|
"value": "1",
|
|
"currency": "USD"
|
|
}
|
|
},
|
|
{
|
|
"type": "TAX",
|
|
"amount": {
|
|
"value": "2",
|
|
"currency": "USD"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"merchant_preferences": {
|
|
"setup_fee": {
|
|
"value": "1",
|
|
"currency": "USD"
|
|
},
|
|
"return_url": "http://www.paypal.com",
|
|
"cancel_url": "http://www.yahoo.com",
|
|
"auto_bill_amount": "YES",
|
|
"initial_fail_amount_action": "CONTINUE",
|
|
"max_fail_attempts": "0"
|
|
}
|
|
}
|
|
},
|
|
"response": {
|
|
"status": "201 Created",
|
|
"headers": {},
|
|
"body": {
|
|
"id": "P-7DC96732KA7763723UOPKETA",
|
|
"state": "CREATED",
|
|
"name": "Sample Plan",
|
|
"description": "Plan with regular and trial",
|
|
"type": "FIXED",
|
|
"payment_definitions": [
|
|
{
|
|
"id": "PD-0MF87809KK310750TUOPKETA",
|
|
"name": "Regular Payment Definition",
|
|
"type": "REGULAR",
|
|
"frequency": "Month",
|
|
"amount": {
|
|
"currency": "USD",
|
|
"value": "100"
|
|
},
|
|
"charge_models": [
|
|
{
|
|
"id": "CHM-89H01708244053321UOPKETA",
|
|
"type": "SHIPPING",
|
|
"amount": {
|
|
"currency": "USD",
|
|
"value": "10"
|
|
}
|
|
},
|
|
{
|
|
"id": "CHM-1V202179WT9709019UOPKETA",
|
|
"type": "TAX",
|
|
"amount": {
|
|
"currency": "USD",
|
|
"value": "12"
|
|
}
|
|
}
|
|
],
|
|
"cycles": "12",
|
|
"frequency_interval": "2"
|
|
},
|
|
{
|
|
"id": "PD-03223056L66578712UOPKETA",
|
|
"name": "Trial Payment Definition",
|
|
"type": "TRIAL",
|
|
"frequency": "Week",
|
|
"amount": {
|
|
"currency": "USD",
|
|
"value": "9.19"
|
|
},
|
|
"charge_models": [
|
|
{
|
|
"id": "CHM-7XN63093LF858372XUOPKETA",
|
|
"type": "SHIPPING",
|
|
"amount": {
|
|
"currency": "USD",
|
|
"value": "1"
|
|
}
|
|
},
|
|
{
|
|
"id": "CHM-6JY06508UT8026625UOPKETA",
|
|
"type": "TAX",
|
|
"amount": {
|
|
"currency": "USD",
|
|
"value": "2"
|
|
}
|
|
}
|
|
],
|
|
"cycles": "2",
|
|
"frequency_interval": "5"
|
|
}
|
|
],
|
|
"merchant_preferences": {
|
|
"setup_fee": {
|
|
"currency": "USD",
|
|
"value": "1"
|
|
},
|
|
"max_fail_attempts": "0",
|
|
"return_url": "http://www.paypal.com",
|
|
"cancel_url": "http://www.yahoo.com",
|
|
"auto_bill_amount": "YES",
|
|
"initial_fail_amount_action": "CONTINUE"
|
|
},
|
|
"create_time": "2014-06-16T07:40:20.940Z",
|
|
"update_time": "2014-06-16T07:40:20.940Z",
|
|
"links": [
|
|
{
|
|
"href": "https://localhost:12379/v1/payments/billing-plans/P-7DC96732KA7763723UOPKETA",
|
|
"rel": "self",
|
|
"method": "GET"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|