Javascript SDK

<script>
  window.Pelcro = {};
  window.Pelcro.siteid = "8989";
  window.Pelcro.environment = {
    domain: "https://staging.pelcro.com",
    ui: "https://js.pelcro.com/ui/plugin/membership-staging/v1/main.min.js",
    stripe: "pk_test_aThAAdvPHgIdAziZweywBWNk"
  };
</script>
<script async src="https://js.pelcro.com/sdk/main.min.js" type="text/javascript"></script>

const siteData = window.Pelcro.site.read();

// full site object
console.log(siteData);

// site products
console.log(siteData.products);

// site logo
console.log(siteData.logo);

// site has ecommerce enabled
console.log(siteData.ecommerce_enabled);

window.Pelcro.site.getById((error, response) => {
  	if (error) {
    	return console.log("error", error.message);
    }
 
    const siteData = response.data;
    console.log(siteData);
})

window.Pelcro.user.register({
    email: "[email protected]",
    password: "123456",
}, (error, response) => {
  	if (error) {
    	return console.log("error", error.message);
    }
 
    const user = response.data;
    console.log(user);
})

window.Pelcro.user.login({
    email: "[email protected]",
    password: "123456",
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

const user = window.Pelcro.user.read();

// full user object
console.log(user);

// user email
console.log(user.email);

// user subscriptions
console.log(user.subscriptions);

// user addresses
console.log(user.addresses);

// user ecommerce orders
console.log(user.orders);

// user metadata object
console.log(user.metadata);

window.Pelcro.user.idpLogin({
    idp_name: "facebook",
    idp_token: "abc1234",
    email: "[email protected]",
    first_name: "john",
    last_name: "doe",
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

window.Pelcro.user.update({
    auth_token: window.Pelcro.user.read().auth_token,
  	email: "[email protected]",
    first_name: "John",
    last_name: "Doe",
    phone: "0123456",
  	display_name: "JohnDoe",
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

window.Pelcro.user.convert({
    old_provider_id: 1234,
    email: "[email protected]",
    password: "123456",
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }
 
    const user = response.data;
    console.log(user);
})

window.Pelcro.user.logout()

window.Pelcro.user.isAuthenticated()

window.Pelcro.user.uploadProfilePicture({
    auth_token: window.Pelcro.user.read().auth_token,
    image: newProfilePictureBlob,
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const newPictureLink = response.data.profile_photo;
    console.log(newPictureLink);
})

window.Pelcro.user.removeProfilePicture({
    auth_token: window.Pelcro.user.read().auth_token,
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

window.Pelcro.user.saveToMetaData({
    auth_token: window.Pelcro.user.read().auth_token,
    key: "savedArticlesIds",
    value: [14,15,88]
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const userMetaData = response.data.metadata;
    console.log(userMetaData);
})

const skuIdToCheck = 1234
window.Pelcro.user.hasOrdered(skuIdToCheck)

const PremiumContentEntitlement = "premium"
const shouldShowPremiumContent  = window.Pelcro.user.isEntitledTo(PremiumContentEntitlement)

window.Pelcro.user.resendEmailVerification((error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

window.Pelcro.user.verifyEmailToken({
    token: "example_token_123",
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

window.Pelcro.user.verifyLoginToken({
    passwordless_token: "example_token_123",
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

window.Pelcro.user.requestLoginToken({
    email: "[email protected]",
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

const selectedPaymentMethodId = 1234

window.Pelcro.subscription.create({
    auth_token: window.Pelcro.user.read().auth_token,
    source_id: selectedPaymentMethodId,
    payment_gateway: "stripe",
    gateway_token: "example_token",
    campaign_key: "my_promotion",
    plan_id: 123,
    address_id: 123,
  	quantity: 1,
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

window.Pelcro.subscription.cancel({
    auth_token: window.Pelcro.user.read().auth_token,
    subscription_id: 123
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

window.Pelcro.subscription.reactivate({
    auth_token: window.Pelcro.user.read().auth_token,
    subscription_id: 123
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

const selectedPaymentMethodId = 1234
const existingSubIdToRenew = 123

window.Pelcro.subscription.renew({
    auth_token: window.Pelcro.user.read().auth_token,
    source_id: selectedPaymentMethodId,
    payment_gateway: "stripe",
    gateway_token: "example_token",
    campaign_key: "my_promotion",
    plan_id: 123,
    address_id: 123,
    subscription_id: existingSubIdToRenew
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

const selectedPaymentMethodId = 1234
const donatedSubscriptionIdToRenew = 123

window.Pelcro.subscription.renewGift({
    auth_token: window.Pelcro.user.read().auth_token,
    source_id: selectedPaymentMethodId,
    payment_gateway: "stripe",
    gateway_token: "example_token",
    plan_id: 123,
    address_id: 123,
    subscription_id: donatedSubscriptionIdToRenew,
  	quantity: 1
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

const existingSubIdToChange = "123"
const planIdToChangeTo = "123"

window.Pelcro.subscription.change({
    plan_id: planIdToChangeTo,
    address_id: "123",
    subscription_id: existingSubIdToChange
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

const futureDate = "2030-07-25"

window.Pelcro.subscription.update({
    subscription_id: 2516554,
    suspend: true,
    shipments_suspended_until: futureDate
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

window.Pelcro.subscription.redeemGift({
    gift_code: "123456",
    address_id: "123"
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const user = response.data;
    console.log(user);
})

window.Pelcro.subscription.list();

const isSubscribed = window.Pelcro.subscription.isSubscribedToPlan({ id:123 });
console.log(isSubscribed);

const isSubscribed = window.Pelcro.subscription.isSubscribedToSite();
console.log(isSubscribed);

const subscriptionID = 2552828

window.Pelcro.subscription.listMembers({
    auth_token:Pelcro.user.read().auth_token,
    subscription_id: subscriptionID,
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const data = response.data;
    console.log(data);
})

const subscriptionID = 2552828

window.Pelcro.subscription.inviteMembers({
    auth_token:Pelcro.user.read().auth_token,
    subscription_id: subscriptionID,
  	emails: ["@example.com", "@example2.com"]
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const data = response.data;
    console.log(data);
})

const subscriptionID = 2552828
const memberID = 2354658

window.Pelcro.subscription.removeMember({
    auth_token:Pelcro.user.read().auth_token,
    subscription_id: subscriptionID,
  	id:memberID
}, (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }

    const data = response.data;
    console.log(data);
})

window.Pelcro.password.forgot({
      email: "[email protected]",
}, (error, response) => {
  	if (error) {
    	return console.log("error", error.message);
    }
 
    const user = response.data;
    console.log(user);
})

window.Pelcro.password.reset({
      email: "[email protected]",
      password: "123456",
      password_confirmation: "123456",
      token: "abc12345xyz"
}, (error, response) => {
  	if (error) {
    	return console.log("error", error.message);
    }
 
    const user = response.data;
    console.log(user);
})

window.Pelcro.password.update({
      old_password: "123456",
      new_password: "123abc",
      confirm_new_password: "123abc"
}, (error, response) => {
  	if (error) {
    	return console.log("error", error.message);
    }
 
    const user = response.data;
    console.log(user);
})

window.Pelcro.address.create({
      type: "shipping",
      first_name: "john",
      last_name: "doe",
      title: "mr",
      company: "abc",
      department: "operations",
      line1: "4 kingston street",
      line2: "apt 15",
      city: "San Francisco",
      state: "CA",
      country: "US",
      postal_code: "12345",
      is_default: true
}, (error, response) => {
  	if (error) {
    	return console.log("error", error.message);
    }
 
    const user = response.data;
    console.log(user);
})

window.Pelcro.address.update({
      address_id: 123,
      type: "shipping",
      first_name: "john",
      last_name: "doe",
      title: "mr",
      company: "abc",
      department: "operations",
      line1: "4 kingston street",
      line2: "apt 15",
      city: "San Francisco",
      state: "CA",
      country: "US",
      postal_code: "12345",
      is_default: true
}, (error, response) => {
  	if (error) {
    	return console.log("error", error.message);
    }
 
    const user = response.data;
    console.log(user);
})

const userAddresses = window.Pelcro.address.list();
console.log(userAddresses);

window.Pelcro.ecommerce.products.list((error, response) => {
	if (error) {
  	return console.log("error", error.message);
  }
 
  const ecomProducts = response.data.products;
  console.log(ecomProducts);
});

window.Pelcro.ecommerce.products.read();

const ecomProduct = window.Pelcro.ecommerce.products.getByProductId(123);

const sku = window.Pelcro.ecommerce.products.getBySkuId(321);

window.Pelcro.ecommerce.order.create(
  {
    items: [
      {
        "sku_id": 34,
        "quantity": 1
      }
    ],
    payment_gateway: "stripe",
    gateway_token: "stripe_1234322111",
    address_id: 123,
    campaign_key: "my_promotion",
  },
  (error, response) => {
    if (error) {
    	return console.log("error", error.message);
  	}
    
    const order = response.data.order;
    console.log(order);
  }
);

window.Pelcro.ecommerce.order.create(
  {
    items: [
      {
        "sku_id": 34,
        "quantity": 1
      }
    ],
    source_id: 123456,
    address_id: 123
  },
  (error, response) => {
    if (error) {
    	return console.log("error", error.message);
  	}
    
    const order = response.data.order;
    console.log(order);
  }
);

window.Pelcro.ecommerce.order.createSummary(
  {
    items: [
      {
        "sku_id": 34,
        "quantity": 1
      }
    ],
    coupon_code: "50off"
  },
  (error, response) => {
    if (error) {
			return console.log("error", error.message);
  	}
    
    const summary = response.data;
    console.log(summary);    
  }
);

window.Pelcro.source.create(
  {
    auth_token: window.Pelcro.user.read().auth_token, 
  	token: "stripe_token"
  },
  (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }
    
    const createdSource = response.data.sources[response.data.sources.length - 1];
    console.log(createdSource);
  }
)

window.Pelcro.source.update(
  {
    auth_token: window.Pelcro.user.read().auth_token, 
  	source_id: 1234,
    cc_exp: "01/25"
  },
  (error, response) => {
    if (error) {
    	return console.log("error", error.message);
  	}
    
    const userPaymentSources = response.data.sources;
    console.log(userPaymentSources);
  }
)

window.Pelcro.paymentMethods.create(
  {
    auth_token: window.Pelcro.user.read().auth_token, 
  	token: "stripe_token",
  },
  (error, response) => {
    if (error) {
    	return console.log("error", error.message);
    }
    
    const createdSource = response.data.sources[response.data.sources.length - 1];
    console.log(createdSource);
  }
)

window.Pelcro.paymentMethods.deletePaymentMethod(
  {
    auth_token: window.Pelcro.user.read().auth_token,
    payment_method_id: 1234
  },
  (error, response) => {
    if (error) {
      return console.log("error", error.message);
    }

    // No response if success
  }
);

window.Pelcro.paymentMethods.update(
  {
    auth_token: window.Pelcro.user.read().auth_token,
    payment_method_id: 1234,
    gateway: "stripe",
    exp_month: 08,
    exp_year: 2029,
    is_default: true,
  },
  (error, response) => {
    if (error) {
      return console.log("error", error.message);
    }

    const updatedPaymentMethod = response.data;
    console.log(updatedPaymentMethod);
  }
);

window.Pelcro.paymentMethods.update(
  {
    auth_token: window.Pelcro.user.read().auth_token,
    payment_method_id: 1234,
    gateway: "vantiv",
    paypageRegistrationId: paypageRegistrationId,
    bin: bin,
    type: "MC",
    firstSix: 526489,
    lastFour: 4444,
    exp_month: 08,
    exp_year: 2029,
    is_default: true,
  },
  (error, response) => {
    if (error) {
      return console.log("error", error.message);
    }

    const updatedPaymentMethod = response.data;
    console.log(updatedPaymentMethod);
  }
);

window.Pelcro.paymentMethods.getPaymentMethod(
  {
    auth_token: window.Pelcro.user.read().auth_token,
    payment_method_id: 1234
  },
  (error, response) => {
    if (error) {
      return console.log("error", error.message);
    }

    const paymentMethod = response.data;
    console.log(paymentMethod);
  }
);

window.Pelcro.paymentMethods.list(
  {
    auth_token: window.Pelcro.user.read().auth_token
  },
  (error, response) => {
    if (error) {
      return console.log("error", error.message);
    }

    const paymentMethodList = response.data;
    console.log(paymentMethodList);
  }
);

const products = window.Pelcro.product.list();

console.log(products);

const targetedProducts = window.Pelcro.product.listByTarget();

console.log(targetedProducts);

const product = window.Pelcro.product.getById(123);

console.log(product);

window.Pelcro.product.getByEntitlements(["gold", "silver"])

const plan = window.Pelcro.plan.getById(123);

console.log(plan);

window.Pelcro.plan.getByIP((error, response) => {
	if (error) {
  	return console.log("error", error.message);
  }
  
  const plans = response;
  console.log(plans);
})

window.Pelcro.plan.getByEmail(
    { 
      email: "[email protected]" 
    },
    (error, resp) => {
			if (error) {
  			return console.log("error", error.message);
      }
      
  		const plans = resp;
  		console.log(plans);          
});

window.Pelcro.plan.getPlan({
  plan_id: 123
}, (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const plan = response.data.plan;
  console.log(plan);
});

window.Pelcro.order.create({
  auth_token: window.Pelcro.user.read().auth_token, 
  plan_id: 1234,
  address_id: 321,
  coupon_code: "50OFF"
}, (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const orderSummary = response.data.plan;
  console.log(orderSummary);
});

const invoices = window.Pelcro.invoice.list();

console.log(invoices);

window.Pelcro.invoice.pay({
  source_id: 12155,
  payment_gateway: 'payment_gateway',
  gateway_token: 'gateway_token'
}, (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const response = response.data;
  console.log(response);
});

/**
 * Callback function for Pelcro.membership.getByIP().
 
 * @param {import('axios').AxiosError|null} error - An AxiosError object if the request failed, or null if successful.
 * @param {Array|{data: Array}|null} memberships - The memberships array or an object containing the memberships array in the 'data' property, or null if an error occurred.
 
 * @returns {any} - Depends on your implementation.
 */
const handleGetMembershipByIPCallback = (error, memberships) => {
  if (error) {
    if (error.response?.status === 404) {
      console.debug("No memberships found for this IP (404)");
      // Handle the "no memberships" case (e.g., display a message, toggle paywall, ...)
      return null; // Or return a specific value indicating no data.
    } else {
      console.error("Error fetching memberships:", error.message);
      // Handle other errors (e.g., display an error message, trigger fallback mechanism logic, ...)
      return null; // Or return an appropriate error value if needed.
    }
  }
  
  // Handle the case where memberships is an object.
  if (memberships && !Array.isArray(memberships) && memberships.data) {
    memberships = memberships.data;
  }
  
  console.debug("IP has matching memberships:", memberships);
  return memberships;
};

window.Pelcro.membership.getByIP(handleGetMembershipByIPCallback);

window.Pelcro.membership.getByEmail(
    { 
      email: "[email protected]" 
    },
    (error, resp) => {
			if (error) {
  			return console.log("error", error.message);
      }
      
  		const memberships = resp;
  		console.log(memberships);          
});

window.Pelcro.campaign.getByID({
    auth_token: window.Pelcro.user.read().auth_token,
    campaign_id: 1,
}, (error, response) => {
    if (error) {
        return console.log("error", error.message);
    }

    const campaign = response.data;
    console.log(campaign);
})

window.Pelcro.campaign.getByKey({
    auth_token: window.Pelcro.user.read().auth_token,
    campaign_key: 1,
}, (error, response) => {
    if (error) {
        return console.log("error", error.message);
    }
    const campaign = response.data;
    console.log(campaign);
})

const activePaywall = window.Pelcro.paywall.read();
console.log(activePaywall);

const paywallProduct = window.Pelcro.paywall.getProduct();
console.log(paywallProduct);

const visitsLeft = window.Pelcro.paywall.freeVisitsLeft();
console.log(visitsLeft);

const shouldDisplayNewsletterPaywall = window.Pelcro.paywall.displayNewsletterPaywall();
console.log(shouldDisplayNewsletterPaywall);

const shouldDisplayMeterPaywall = window.Pelcro.paywall.displayMeterPaywall();
console.log(shouldDisplayMeterPaywall);

const shouldDisplayPlansPaywall = window.Pelcro.paywall.displayPaywall(false);
console.log(shouldDisplayPlansPaywall);

const isArticleRestricted = window.Pelcro.paywall.isArticleRestricted();
console.log(isArticleRestricted);

window.Pelcro.newsletter.create({
  email: "[email protected]",
}, (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const newsletter = response.data;
  console.log(newsletter);
});

window.Pelcro.newsletter.getByEmail("[email protected]", (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const orderSummary = response.data.plan;
  console.log(orderSummary);
});)

window.Pelcro.newsletter.update({
  email: "[email protected]",
}, (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const newsletter = response.data;
  console.log(newsletter);
});

const isSubscribedToNewsletter = window.Pelcro.newsletter.isSubscribedToNewsletter();
console.log(isSubscribedToNewsletter);

const couponCode = window.Pelcro.coupon.getFromUrl();
console.log(couponCode);

window.Pelcro.insight.track("Button clicked");

window.Pelcro.insight.track("Button clicked", {
    "name": "Facebook like",
    "color": "Blue"
});

window.Pelcro.insight.getPlansRecommendations(
  {
    user_id: 23221
  },
  (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const plansRecommendations = response;
  console.log(plansRecommendations);
});

window.Pelcro.insight.getSubscriptionPrediction(
  {
    user_id: 23221
  },
  (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const subPredictions = response;
  console.log(subPredictions);
});

window.Pelcro.insight.getChurnPrediction(
  {
    user_id: 23221
  },
 (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const churnPredictions = response;
  console.log(churnPredictions);
});

window.Pelcro.insight.getContentRecommendations(
 {
   user_id: 23221,
 },
  (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const contentRecommendations = response;
  console.log(contentRecommendations);
});

window.Pelcro.insight.getContentRecommendations(
 {
   user_id: 23221,
   filter: ["filter", "tags"],
   boost: ["tags", "to", "boost"],
 },
 (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const contentRecommendations = response;
  console.log(contentRecommendations);
});

window.Pelcro.insight.getContentRecommendations(
 {
   user_id: 23221,
   filter: ["filter", "tags"],
   boost: ["tags", "to", "boost"],
   boost_paywalled: true
 },
 (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const contentRecommendations = response;
  console.log(contentRecommendations);
});

window.Pelcro.integrations.disqus.getToken((error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const {disqus_auth_key, disqus_public_key} = response.data;
  console.log("disqus_auth_key", disqus_auth_key);
  console.log("disqus_public_key", disqus_public_key);
});

const giftCode = window.Pelcro.helpers.getURLParameter("gift_code");
console.log(giftCode);

window.Pelcro.helpers.loadSDK(
  "https://js.stripe.com/v3.js",
  "pelcro-sdk-stripe"
);

Pelcro.helpers.loadCSS(
  "https://js.stripe.com/v3/integrations/812.css",
  "pelcro-css-stripe"
);

window.Pelcro.environment.ui = " ";

window.Pelcro.user.login({
    email: "[email protected]",
    password: "INVALID_PASSWORD",
}, (error, response) => {
    if (error) {
    	console.log("error", error.response.data.error.message); // "Invalid credentials! Please try again."
    	console.log("error", error.response.data.error.status); // 404
    }
})