Ballerina PayPal Subscriptions connector

Overview

PayPal is a global online payment platform enabling individuals and businesses to securely send and receive money, process transactions, and access merchant services across multiple currencies.

The ballerinax/paypal.subscriptions package provides a Ballerina connector for interacting with the PayPal Subscriptions API v1, allowing you to create, manage, and monitor subscription-based billing plans and subscriptions in your Ballerina applications.

Setup Guide

To use the PayPal Subscriptions connector, you must have access to a PayPal Developer account.

Step 1: Create a business account

1. Open the PayPal Developer Dashboard.

   

2. Create a business account.

   Note: Some PayPal options and features may vary by region or country; check availability before creating an account.

   

Step 2: Create a REST API app

1. Navigate to the "Apps and Credentials" tab and create a new merchant app.
2. Provide a name for the application and select the Business account created earlier.

Step 3: Obtain Client ID and Client Secret

1. After creating the app, you will see your Client ID and Client Secret. Copy and securely store these credentials.

   

Quickstart

To use the paypal.subscriptions connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module

Import the paypal.subscriptions module.

import ballerinax/paypal.subscriptions as paypal;

Step 2: Instantiate a new connector

1. Create a Config.toml file and configure the obtained credentials and URLs:

   clientId = "<your-client-id>"
   clientSecret = "<your-client-secret>"
   
   serviceUrl = "<paypal-service-url>"
   tokenUrl = "<paypal-token-url>"

2. Create a paypal:ConnectionConfig with the credentials and initialize the connector:

   configurable string clientId = ?;
   configurable string clientSecret = ?;
   configurable string serviceUrl = ?;
   configurable string tokenUrl = ?;
   
   final paypal:Client paypal = check new ({
       auth: {
           clientId,
           clientSecret,
           tokenUrl
       }
   }, serviceUrl);

Step 3: Invoke a connector operation

Create a subscription plan

public function main() returns error? {
    paypal:PlanRequestPOST plan = {
        product_id: "PROD-1234567890",
        name: "Basic Subscription Plan",
        status: "ACTIVE",
        billing_cycles: [
            {
                frequency: {
                    interval_unit: "MONTH",
                    interval_count: 1
                },
                tenure_type: "REGULAR",
                sequence: 1,
                total_cycles: 0,
                pricing_scheme: {
                    fixed_price: {
                        value: "10.00",
                        currency_code: "USD"
                    }
                }
            }
        ],
        payment_preferences: {
            auto_bill_outstanding: true,
            setup_fee: {
                value: "0.00",
                currency_code: "USD"
            },
            setup_fee_failure_action: "CONTINUE",
            payment_failure_threshold: 3
        }
    };
    paypal:Plan response = check paypal->/plans.post(plan);
}

Step 4: Run the Ballerina application

bal run

Examples

The PayPal Subscriptions connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

1. Create and List Plans: Create a subscription plan and list all available plans.
2. Monitor and Manage Subscription Status: Retrieve a subscription’s status and suspend or reactivate it based on its state.
3. Manage Premium Subscription: Create a subscription plan, enroll a customer, and retrieve subscription details for a premium membership.

Build from the source

Setting up the prerequisites

1. Download and install Java SE Development Kit (JDK) version 21. You can download it from either of the following sources:

   • Oracle JDK
   • OpenJDK

   Note: After installation, remember to set the JAVA_HOME environment variable to the directory where JDK was installed.

2. Download and install Ballerina Swan Lake.

3. Download and install Docker.

   Note: Ensure that the Docker daemon is running before executing any tests.

4. Export Github Personal access token with read package permissions as follows,

   export packageUser=<Username>
   export packagePAT=<Personal access token>

Build options

Execute the commands below to build from the source.

1. To build the package:

   ./gradlew clean build

2. To run the tests:

   ./gradlew clean test

3. To build without the tests:

   ./gradlew clean build -x test

4. To run tests against different environments:

   ./gradlew clean test -Pgroups=<Comma separated groups/test cases>

5. To debug the package with a remote debugger:

   ./gradlew clean build -Pdebug=<port>

6. To debug with the Ballerina language:

   ./gradlew clean build -PbalJavaDebug=<port>

7. Publish the generated artifacts to the local Ballerina Central repository:

   ./gradlew clean build -PpublishToLocalCentral=true

8. Publish the generated artifacts to the Ballerina Central repository:

   ./gradlew clean build -PpublishToCentral=true

Contribute to Ballerina

As an open-source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All contributors are encouraged to read the Ballerina Code of Conduct.

Useful links

• For more information, go to the paypal.subscriptions package.
• For example demonstrations of the usage, go to Ballerina By Examples.
• Chat live with us via our Discord server.
• Post all technical questions on Stack Overflow with the #ballerina tag.