Test and go live with Subscriptions

You can run negative tests on your integration to manage the responses you give to your customers.

Know before you code

• Before you trigger a simulation, you'll need to you need to get an access token.

• Use Postman to explore and test PayPal APIs.

Test flow

Test a transaction to see the subscription created in the merchant account.

Test the transaction as a buyer

1. Select the PayPal button on the page.

2. Use the sandbox personal login information from the Developer Dashboard to log in and simulate the buyer making a purchase.

3. 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

1. 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.
2. Confirm the subscription appears in the active automatic payment list. Select the active automatic payment to see the details of the subscription.
3. Log out of the account.

Confirm funds move to the merchant account

1. 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.
2. Confirm the subscription made by the test buyer appears on the Subscriptions tab. Select the subscription to see the details of the subscription.
3. 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

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

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:

Product

• Create product
• Get product
• List products
• Update product

Plan

• Create plan
• Activate plan
• Deactivate plan
• Get plan
• List plans
• Update plan
• Change plan pricing

Subscription

• Create subscription
• Activate subscriptions
• Get subscription
• Update subscription
• Revise subscription
• Suspend subscription
• Capture subscription
• Get subscription transaction
• Cancel subscription

Product

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.

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}.

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}.

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}.

Plan

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/.

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.

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.

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}.

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}.

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}.

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.

Subscription

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.

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.

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}.

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}.

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.

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.

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.

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.

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.

Error handling

An error includes:

• The error name and description.
• A link to error-related documentation.
• A debug ID.
• Error details.

API errors

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

1. Change the base URL for all your REST API calls from https://api-m.sandbox.paypal.com to https://api-m.paypal.com.
2. Change the references to your sandbox API credentials to the live credentials. To get live API credentials, create a live REST API.