Zum Hauptinhalt springen

Documentation

IMPORTANT

This is the outdated SI-documentation which will be adapted soon. A huge part may be obsolete!

Rest Api Requests

This automation allows you to setup REST API Requests to an external website when an order on the site has their status set to either of the following:

  • Being Activated

  • Being Refunded

  • Being Expired

Rest API

Activated

When a subscription on the site is activated, PayPlans would trigger any automations that you have and fire these REST API Requests that you have created

  • URL
    This is where you set the endpoint for your rest api.

  • Variables
    This is where you set a key value pair that should be sent to your rest api. The value here should be url encoded. You may also use token as values in the variable.

    Example:

    key=value&action=something
    

Refunded

Triggered when a subscription on the site is refunded to the customer.

  • URL
    This is where you set the endpoint for your rest api.

  • Variables
    This is where you set a key value pair that should be sent to your rest api. The value here should be url encoded. You may also use token as values in the variable.

    Example:

    key=value&action=something
    

Expired

When a subscription expires, PayPlans would trigger the REST API Requests created for this.

  • URL
    This is where you set the endpoint for your rest api.

  • Variables
    This is where you set a key value pair that should be sent to your rest api. The value here should be url encoded. You may also use token as values in the variable.

    Example:

    key=value&action=something