Test and go live with Subscriptions
Last updated: Feb 27th, 8:14am
You can run negative tests on your integration to manage the responses you give to your customers.
Know before you code
RequiredYou'll need OAuth 2.0 tokens to authenticate requests
OptionalExplore PayPal APIs with Postman
Use Postman to explore and test PayPal APIs. Learn more in our Postman guide
Test flow
Test a transaction to see the subscription created in the merchant account.
Test the transaction as a buyer
- Select the PayPal button on the page.
- Use the sandbox personal login information from the Developer Dashboard to log in and simulate the buyer making a purchase.
- In the Checkout window, notice the purchase amount in the upper right corner. USD is the default currency. You can customize the PayPal JavaScript SDK with different currency codes.
Availability: The JavaScript SDK onShippingChange, onShippingAddressChange, and onShippingOptionsChange functions are not compatible with Subscriptions.
4. Select the pull-down arrow next to the purchase amount. The subscription details are available for the buyer to review. It should appear similar to the following image:
5. Complete the flow.
Confirm funds move from the buyer account
- Use the sandbox personal account you used to complete the purchase to log in to https://www.sandbox.paypal.com/myaccount/autopay/connect/. This URL takes you to the automatic payments page in the sandbox personal account.
- Confirm the subscription appears in the active automatic payment list. Select the active automatic payment to see the details of the subscription.
- Log out of the account.
Confirm funds move to the merchant account
- Use the sandbox business account information from the Developer Dashboard to log in to https://www.sandbox.paypal.com/billing/subscriptions. This URL takes you to the subscriptions management page in the sandbox business account.
- Confirm the subscription made by the test buyer appears on the Subscriptions tab. Select the subscription to see the details of the subscription.
- Log out of the account.
Simulation methods
To trigger a simulation for the Subscriptions API, you can use either a JSON pointer in the request payload or a path parameter in the request URI.
Use a JSON pointer in the request payload
| Trigger | Test value | Simulated error response |
|---|---|---|
plan_id |
ERRSUB033 |
NOT_AUTHORIZED |
Request
1curl -X POST \2 https://api-m.sandbox.paypal.com/v1/billing/subscriptions \3 -H 'Authorization: Bearer <Access Token>'4 -d '{5 "plan_id": "ERRSUB033",6 "start_time": "2020-02-06T15:00:00Z",7 "quantity": "1",8 "shipping_amount": {9 "currency_code": "USD",10 "value": "12.00"11 },12 "subscriber": {13 "name": {14 "given_name": "John",15 "surname": "Doe"16 },17 "email_address": "customer@example.com",18 "shipping_address": {19 "name": {20 "full_name": "John Doe"21 },22 "address": {23 "address_line_1": "2211 N First Street",24 "address_line_2": "Building 17",25 "admin_area_2": "San Jose",26 "admin_area_1": "CA",27 "postal_code": "95131",28 "country_code": "US"29 }30 }31 },32 "application_context": {33 "brand_name": "Walmart Inc",34 "locale": "en-US",35 "shipping_preference": "SET_PROVIDED_ADDRESS",36 "user_action": "SUBSCRIBE_NOW",37 "payment_method": {38 "payer_selected": "PAYPAL_CREDIT",39 "payee_preferred": "IMMEDIATE_PAYMENT_REQUIRED"40 },41 "return_url": "http://zoho.com/returnUrl",42 "cancel_url": "http://zoho.com/cancelUrl"43 }44 }'
Response
1{2 "name": "NOT_AUTHORIZED",3 "debugId": "b1d1f06c7246c",4 "message": "Authorization failed due to insufficient permissions.",5 "details": [6 {7 "issue": "PERMISSION_DENIED",8 "description": "You do not have permission to access or perform operations on this resource."9 }10 ],11 "links": [12 {13 "href": "https://developer.paypal.com/docs/api/v1/billing/subscriptions#PERMISSION_DENIED",14 "rel": "information_link",15 "method": "GET"16 }17 ]18}
Use a path parameter in the request URI
| Trigger or test value | Simulated error response |
|---|---|
v1/billing/subscriptions/ERRSUB068/activate |
RESOURCE_NOT_FOUND |
Request
1curl -X GET \2 https://api-m.sandbox.paypal.com/v1/billing/subscriptions/ERRSUB068/activate \3 -H 'Authorization: Bearer <Access Token>' \4 -H 'Content-Type: application/json' \5 -d '{6 "reason": "Reactivating the subscription"7 }8}'
Response
1{2 "name": "RESOURCE_NOT_FOUND",3 "message": "The specified resource does not exist.",4 "debug_id": "c2d1f06c7246c",5 "details": [6 {7 "issue": "INVALID_RESOURCE_ID",8 "description": "Requested resource ID was not found",9 "value": "I-TT452GLLEP1G"10 }11 ],12 "links": [13 {14 "href": "https://developer.paypal.com/docs/api/v1/billing/subscriptions#RESOURCE_NOT_FOUND,15 "rel": "information_link"16 }17 ]18}
Test values
Use the following test values to trigger positive and negative responses for these subscriptions actions:
- Create subscription
- Activate subscriptions
- Get subscription
- Update subscription
- Revise subscription
- Suspend subscription
- Capture subscription
- Get subscription transaction
- Cancel subscription
Product
Note: Test values are case sensitive.
Create product
Negative response test values
Use the JSON pointer in the request payload to simulate the following error responses at POST /v1/catalogs/products.
| Trigger | Test value | Simulated error response |
|---|---|---|
name |
ERRCAT001 |
INTERNAL_SERVER_ERROR |
name |
ERRCAT002 |
NOT_AUTHORIZED |
name |
ERRCAT003 |
INVALID_REQUEST |
name |
ERRCAT004 |
INVALID_REQUEST |
name |
ERRCAT005 |
UNPROCESSABLE_ENTITY |
Get product
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at GET /v1/catalogs/products/{test_value}.
| Trigger or test value | Simulated error response |
|---|---|
/v1/catalogs/products/ERRCAT008 |
INTERNAL_SERVER_ERROR |
/v1/catalogs/products/ERRCAT009 |
NOT_AUTHORIZED |
/v1/catalogs/products/ERRCAT010 |
RESOURCE_NOT_FOUND |
List products
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at GET /v1/billing/plans/?&total_required={test_value}.
| Trigger or test value | Simulated error response |
|---|---|
/v1/catalogs/products?total_required=ERRCAT006 |
INTERNAL_SERVER_ERROR |
/v1/catalogs/products?total_required=ERRCAT007 |
NOT_AUTHORIZED |
Update product
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at PATCH /v1/catalog/products/{test_value}.
| Trigger or test value | Simulated error response |
|---|---|
/v1/catalogs/products/ERRCAT011 |
INTERNAL_SERVER_ERROR |
/v1/catalogs/products/ERRCAT012 |
NOT_AUTHORIZED |
/v1/catalogs/products/ERRCAT013 |
INVALID_REQUEST |
/v1/catalogs/products/ERRCAT014 |
UNPROCESSABLE_ENTITY |
Plan
Note: Test values are case sensitive.
Create plan
Negative response test values
Use the JSON pointer in the request payload to simulate the following error responses at POST /v1/billing/plans/.
| Trigger | Test value | Simulated error response |
|---|---|---|
name |
ERRSUB001 |
INTERNAL_SERVER_ERROR |
name |
ERRSUB002 |
NOT_AUTHORIZED |
name |
ERRSUB003 |
INVALID_REQUEST |
name |
ERRSUB004 |
UNPROCESSABLE_ENTITY |
Activate plan
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at POST/v1/billing/plans/{test_value}/activate.
| Trigger or test value | Simulated error response |
|---|---|
/v1/billing/plans/ERRSUB015/activate |
INTERNAL_SERVER_ERROR |
/v1/billing/plans/ERRSUB016/activate |
NOT_AUTHORIZED |
/v1/billing/plans/ERRSUB017/activate |
RESOURCE_NOT_FOUND |
/v1/billing/plans/ERRSUB018/activate |
UNPROCESSABLE_ENTITY |
Deactivate plan
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at POST /v1/billing/plans/{test_value}/deactivate.
| Trigger or test value | Simulated error response |
|---|---|
/v1/billing/plans/ERRSUB019/deactivate |
INTERNAL_SERVER_ERROR |
/v1/billing/plans/ERRSUB020/deactivate |
NOT_AUTHORIZED |
/v1/billing/plans/ERRSUB021/deactivate |
RESOURCE_NOT_FOUND |
/v1/billing/plans/ERRSUB022/deactivate |
UNPROCESSABLE_ENTITY |
Get plan
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at GET /v1/billing/plans/{test_value}.
| Trigger or test value | Simulated error response |
|---|---|
/v1/billing/plans/ERRSUB008 |
INTERNAL_SERVER_ERROR |
/v1/billing/plans/ERRSUB009 |
NOT_AUTHORIZED |
/v1/billing/plans/ERRSUB009 |
RESOURCE_NOT_FOUND |
List plans
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at GET /v1/billing/plans/?page_size=3&page=1&total_required={test_value}.
| Trigger or test value | Simulated error response |
|---|---|
/v1/billing/plans?page_size=3&page=1&total_required=ERRSUB005 |
INTERNAL_SERVER_ERROR |
/v1/billing/plans?page_size=3&page=1&total_required=ERRSUB006 |
NOT_AUTHORIZED |
/v1/billing/plans?page_size=3&page=1&total_required=ERRSUB007 |
INVALID_REQUEST |
Update plan
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at PATCH /v1/billing/plans/{test_value}.
| Trigger or test value | Simulated error response |
|---|---|
/v1/billing/plans/ERRSUB011 |
INTERNAL_SERVER_ERROR |
/v1/billing/plans/ERRSUB012 |
NOT_AUTHORIZED |
/v1/billing/plans/ERRSUB013 |
RESOURCE_NOT_FOUND |
/v1/billing/plans/ERRSUB014 |
INVALID_REQUEST |
Change plan pricing
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at POST /v1/billing/plans/{test_value}/update-pricing-schemes.
| Trigger or test value | Simulated error response |
|---|---|
/v1/billing/plans/ERRSUB023/update-pricing-schemes |
INTERNAL_SERVER_ERROR |
/v1/billing/plans/ERRSUB024/update-pricing-schemes |
NOT_AUTHORIZED |
/v1/billing/plans/ERRSUB025/update-pricing-schemes |
INVALID_REQUEST |
/v1/billing/plans/ERRSUB026/update-pricing-schemes |
RESOURCE_NOT_FOUND |
/v1/billing/plans/ERRSUB027/update-pricing-schemes |
UNPROCESSABLE_ENTITY |
/v1/billing/plans/ERRSUB028/update-pricing-schemes |
UNPROCESSABLE_ENTITY |
/v1/billing/plans/ERRSUB029/update-pricing-schemes |
UNPROCESSABLE_ENTITY |
/v1/billing/plans/ERRSUB030/update-pricing-schemes |
UNPROCESSABLE_ENTITY |
/v1/billing/plans/ERRSUB031/update-pricing-schemes |
UNPROCESSABLE_ENTITY |
Subscription
Note: Test values are case sensitive.
Create subscription
Negative response test values
Use the JSON pointer in the request payload to simulate the following error responses at POST /v1/billing/subscriptions.
| Trigger | Test value | Simulated error response |
|---|---|---|
plan_id |
ERRSUB032 |
INTERNAL_SERVER_ERROR |
plan_id |
ERRSUB033 |
NOT_AUTHORIZED |
plan_id |
ERRSUB034 |
INVALID_REQUEST |
plan_id |
ERRSUB035 |
INVALID_REQUEST |
plan_id |
ERRSUB036 |
INVALID_REQUEST |
plan_id |
ERRSUB037 |
INVALID_REQUEST |
plan_id |
ERRSUB038 |
INVALID_REQUEST |
plan_id |
ERRSUB039 |
UNPROCESSABLE_ENTITY |
plan_id |
ERRSUB040 |
UNPROCESSABLE_ENTITY |
Activate subscriptions
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at POST /v1/billing/subscriptions/{test_value}/activate.
| Trigger or test value | Simulated error response |
|---|---|
/v1/billing/subscriptions/ERRSUB066/activate |
INTERNAL_SERVER_ERROR |
/v1/billing/subscriptions/ERRSUB067/activate |
NOT_AUTHORIZED |
/v1/billing/subscriptions/ERRSUB068/activate |
RESOURCE_NOT_FOUND |
/v1/billing/subscriptions/ERRSUB069/activate |
UNPROCESSABLE_ENTITY |
/v1/billing/subscriptions/ERRSUB070/activate |
UNPROCESSABLE_ENTITY |
Get subscription
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at GET /v1/billing/subscriptions/{test_value}.
| Trigger or test value | Simulated error response |
|---|---|
/v1/billing/subscriptions/ERRSUB044 |
INTERNAL_SERVER_ERROR |
/v1/billing/subscriptions/ERRSUB045 |
NOT_AUTHORIZED |
/v1/billing/subscriptions/ERRSUB046 |
RESOURCE_NOT_FOUND |
Update subscription
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at PATCH /v1/billing/subscriptions/{test_value}.
| Trigger or test value | Simulated error response |
|---|---|
/v1/billing/subscriptions/ERRSUB047 |
INTERNAL_SERVER_ERROR |
/v1/billing/subscriptions/ERRSUB048 |
NOT_AUTHORIZED |
/v1/billing/subscriptions/ERRSUB049 |
RESOURCE_NOT_FOUND |
/v1/billing/subscriptions/ERRSUB050 |
INVALID_REQUEST |
/v1/billing/subscriptions/ERRSUB051 |
UNPROCESSABLE_ENTITY |
/v1/billing/subscriptions/ERRSUB052 |
UNPROCESSABLE_ENTITY |
Revise subscription
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at POST /v1/billing/subscriptions/{test_value}/revise.
| Trigger or test value | Simulated error response |
|---|---|
/v1/billing/subscriptions/ERRSUB053/revise |
INTERNAL_SERVER_ERROR |
/v1/billing/subscriptions/ERRSUB054/revise |
NOT_AUTHORIZED |
/v1/billing/subscriptions/ERRSUB055/revise |
INVALID_REQUEST |
/v1/billing/subscriptions/ERRSUB056/revise |
UNPROCESSABLE_ENTITY |
Suspend subscription
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at POST /v1/billing/subscriptions/{test_value}/suspend.
| Trigger or test value | Simulated error response |
|---|---|
/v1/billing/subscriptions/ERRSUB059/suspend |
INTERNAL_SERVER_ERROR |
/v1/billing/subscriptions/ERRSUB060/suspend |
NOT_AUTHORIZED |
/v1/billing/subscriptions/ERRSUB061/suspend |
INVALID_REQUEST |
/v1/billing/subscriptions/ERRSUB062/suspend |
UNPROCESSABLE_ENTITY |
Capture subscription
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at POST /v1/billing/subscriptions/{test_value}/capture.
| Trigger or test value | Simulated error response |
|---|---|
/v1/billing/subscriptions/ERRSUB071/capture |
INTERNAL_SERVER_ERROR |
/v1/billing/subscriptions/ERRSUB072/capture |
NOT_AUTHORIZED |
/v1/billing/subscriptions/ERRSUB073/capture |
RESOURCE_NOT_FOUND |
/v1/billing/subscriptions/ERRSUB074/capture |
INVALID_REQUEST |
/v1/billing/subscriptions/ERRSUB075/capture |
INVALID_REQUEST |
Get subscription transaction
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at GET /v1/billing/subscriptions/{test_value}/transactions.
| Trigger or test value | Simulated error response |
|---|---|
/v1/billing/subscriptions/ERRSUB076/transactions |
INTERNAL_SERVER_ERROR |
/v1/billing/subscriptions/ERRSUB076/transactions |
NOT_AUTHORIZED |
/v1/billing/subscriptions/ERRSUB076/transactions |
RESOURCE_NOT_FOUND |
/v1/billing/subscriptions/ERRSUB076/transactions |
INVALID_REQUEST |
Cancel subscription
Negative response test values
Use the path parameter in the request URI method to simulate the following error responses at POST /v1/billing/subscriptions/{test_value}/cancel.
| Trigger or test value | Simulated error response |
|---|---|
/v1/billing/subscriptions/ERRSUB063/cancel |
INTERNAL_SERVER_ERROR |
/v1/billing/subscriptions/ERRSUB064/cancel |
NOT_AUTHORIZED |
/v1/billing/subscriptions/ERRSUB065/cancel |
RESOURCE_NOT_FOUND |
Error handling
An error includes:
- The error name and description.
- A link to error-related documentation.
- A debug ID.
- Error details.
API errors
| HTTP status code | Error name | Message | Details |
|---|---|---|---|
400 |
INVALID_REQUEST |
Request is not well-formed, syntactically incorrect, or violates schema. | A required field is missing. |
401 |
AUTHENTICATION_FAILURE |
Authorization error occurred. | Authorization error occurred. Check your credentials. |
403 |
NOT_AUTHORIZED |
Authorization failed due to insufficient permissions. | You do not have permission to access or perform operations on this resource. |
404 |
RESOURCE_NOT_FOUND |
The specified resource does not exist. | Requested resource ID was not found. |
422 |
UNPROCESSABLE_ENTITY |
The requested action could not be performed, semantically incorrect, or failed business validation. | Invalid plan status for activate action; plan status should be either inactive or created. |
500 |
INTERNAL_SERVER_ERROR |
An internal server error has occurred. | Resend the request at another time. If this error continues, contact PayPal Merchant Technical Support. |
Sample error response
1{2 "name": "INVALID_REQUEST",3 "message": "Request is not well-formed, syntactically incorrect, or violates schema",4 "debug_id": "6u3y6fca61718",5 "details": [{6 "field": "/plan_id",7 "issue": "MISSING_REQUIRED_PARAMETER",8 "description": "A required field is missing.",9 "location": "body"10 }],11 "links": [{12 "href": "https://developer.paypal.com/docs/api/v2/payments/#INVALID_REQUEST",13 "rel": "information_link",14 "method": "GET"15 }]16}
Go live
- Change the base URL for all your REST API calls from
https://api-m.sandbox.paypal.comtohttps://api-m.paypal.com. - Change the references to your sandbox API credentials to the live credentials. To get live API credentials, create a live REST API.