Prestashop Integration Framework

# PrestaShop Billing CDC

This the technical documentation of the Billing CDC components.

The API documentation for the Billing CDC is available here (opens new window).

# Context

TIP

Nested properties are noted with . For example organization.uuid translates to { organization: { uuid: '' } }

Property Type Description Modifiable
contextVersion number The version of the context No
billingEnv string Denotes the current environment of prestashop billing No
isSandbox boolean Sandbox mode No
i18n.isoCode string The shop's language iso code No
accessToken string This token identifies the shop No
shop.uuid string The uuid of the shop No
shop.domain string The domain of the shop, for example sub.domain.ltd No
organization.uuid string The uuid of the organization No
organization.email string The email of the organization No
organization.logoSrc base64 A base64 representation of the organization's logo Yes
product.id string The technical name of the product No
product.displayName string The human readable product's name No
product.logoSrc base64 A base64 representation of the product's logo No
product.privacyUrl string A link to the privacy rules partaining to the product Yes
product.tosUrl string A link to the tos partaining to the product Yes

# psBilling.initialize()

Initialize the Ps Billing CDC (cross-domain component). For your convenience, module-lib-billing creates the required context object (see the tutorial for further reading on how it is implemented).

function initialize(
  context: Context,
  domComponentSelector: string,
  domModalSelector: string,
  onEventHookCallback: (type: EVENT_HOOK_TYPE, data: unknown) => void,
  hideInvoiceList = true,
);
  • context: an object holding key informations about the shop and your module. For more information on all available properties, see below.

TIP

Modifiable properties may be modified via the use of the present method of the ps_billings_facade in module-lib-billing.

$billingFacade->present([
    'logo' => $partnerLogo,
    'tosLink' => 'https://yoururl/',
    'privacyLink' => 'https://yoururl/',
    // This field is deprecated, but must be provided to ensure backward compatibility
    'emailSupport' => ''
]);
  • billingSelector: the DOM element on which Ps Billing will be attached.
  • modalSelector: the DOM element on which the modals of Ps Billing will be attached.
  • callback:
  • hideInvoiceList: whether to hide or show the invoice list.

# psBilling.overrideContext()

You may sometimes need to override the context, and for this, we are providing this method that helps you do just that.

type NestedObject = {
  [key: string]: NestedObject | any;
};

function overrideContext(
  baseObject: NestedObject,
  propertyPath: string[],
  overrideValue: unknown
): NestedObject {

Example usage:

const baseObject = {
  level1: {
    level2: {
      level3: {
        value: 42,
      },
    },
  },
};

const updatedObject = overrideProperty(baseObject, ['level1', 'level2', 'level3', 'value'], 99);

console.log(updatedObject.level1.level2.level3.value); // 99
  • baseObject A base context object of undefined depth.
  • propertyPath An array of strings of undefined length, representing from left to right the property you want to override by accessing each preceding node in the object.
  • overrideValue The value that will override the rightmost string in propertyPath.

# Event Hook Documentation

# Overview

Event hooks can be triggered by two of our cross-domain components: ModalComponent and SubscriptionCheckoutComponent. These hooks notify the system when specific actions occur, enabling seamless communication between components and ensuring a consistent user experience.

# Event Hook Types

The table below lists the available event hooks, their corresponding constants, descriptions, and the components that can trigger them:

Value / Constant Description Component
billing:subscription_created
EVENT_HOOK_TYPE.SUBSCRIPTION_CREATED		 Triggered when a subscription is created. ModalComponent, SubscriptionCheckoutComponent
billing:subscription_updated
EVENT_HOOK_TYPE.SUBSCRIPTION_UPDATED		 Triggered when a subscription is updated. ModalComponent, SubscriptionCheckoutComponent
billing:subscription_cancelled
EVENT_HOOK_TYPE.SUBSCRIPTION_CANCELLED		 Triggered when a subscription is cancelled. ModalComponent
billing:subscription_reactivated
EVENT_HOOK_TYPE.SUBSCRIPTION_REACTIVATED		 Triggered when a subscription is reactivated after cancellation. ModalComponent
billing:subscription_funnel_closed
EVENT_HOOK_TYPE.SUBSCRIPTION_FUNNEL_CLOSED		 Triggered when the checkout funnel is closed, either by clicking the continue button or closing the full-screen modal. ModalComponent

# Deprecated Hooks

The following event hooks are deprecated and should no longer be used:

  • billing:billing_initialized
  • billing:checkout_state

← FAQ →